[WIP] Rebuild and Improve Docker Container

[JSzaszvari]

This is a WIP, Few minor changes needed before its good to go.

This is a complete refactor of the current Rocket.Chat Hubot Docker Container with a bunch of improvements.

Fixes #198 #236 #258 #262 #279 #237

GOOD TO KNOW:

• Using HubotV3 and the new Rocket.Chat adapter, courtesy of @timkinnane
• Container size has been reduced from 722mb to 139mb with no loss in features/functionality
• Basic checks and output during container startup so that if someone forgets to set an environment var they will know what particular setting has not been set.
• Container now handled SIGINT's properly and exits when it should

COMPLETE

• Improve handling of EXTERNAL_SCRIPTS
• Support for loading scripts from an external mounted volume with docker.
• Custom NPM registry support [WIP] Rebuild and Improve Docker Container #289
• CoffeeScript not loading with hubotv3 - Solved with a fix from Robot loadFile and parseHelp tests and method improvements hubotio/hubot#1378

TODO/IN PROGRESS:

• Add a GIT_SCRIPTS env var so people can pull scripts into their container on startup from their own private git repos
• Add a message to the current container's startup process so that it lets people know that there is a new version using hubotv3 and lots of other improvements. (don't want to break everyone using the hubot-rocketchat:latest image)
• Update Documentation

Will update this list above over the next day or so, Making some changes and compiling a list of changes.

DISCUSS:

• I think this should go into its own seperate git repo ( rocketchat-hubot3-docker or something like that) so that it's not in the same repo as the adapter? Thoughts? We will keep it in this repo and make it the default in order not to complicate things with too many unnecessary repos

• Initially push this up to Docker hub with a v3 tag so rocketchat-hubot:v3 and not the default tag so we can get feedback and then once backward compatibility has been confirmed, we can push it to the default tag

[JSzaszvari]

Some screenshots of various things

The output on startup if something needs to be set that isn't

Info/Warnings on startup letting you know what isnt set so you know what your missing out on

[JSzaszvari]

@timkinnane more to come over the next day, then everything should work well.

@geekgonecrazy @timkinnane / Anyone else - Any input/suggestions is welcome. Want to make sure this container is Uber Awesome

[JSzaszvari]

Fancy banner added as well.. Because whats life without a bit of spice

[JSzaszvari]

@timkinnane I re-wrote the hubot-reload-scripts package to be in JS instead of CoffeeSCrap as i wanted it during testing. Turns out the NPM package "hubot-reload" dissapeared and only "hubot-reload-scripts" is online any more (hubot-reload is mine now! haha)

https://github.com/JSzaszvari/hubot-reload

I also combined the reload script + your test/diagnostic scripts into a hubot-rocketchat-diagnostics package and published to NPM

https://github.com/JSzaszvari/hubot-rocketchat-diagnostics

Did this to make my testing easier, dont need to use it, rather just saved me from having to gather them all repeatedly/list multiple packages

My current line of thinking is I want an environment variable for this docker image

ROCKETCHAT_BOT_DIAGNOSTICS=true

which then enables this package and a whole bunch of test tools without needing to source individual packages , your scripts, hubot-reload + a few others I'm yet to commit

[timkinnane]

This is awesome stuff @JSzaszvari - thanks so much. Love the detail provided and the new banner most of all. I'm on leave for a couple weeks but I've checked this out and will test on my way somewhere.

[geekgonecrazy]

This PR is fantastic! Massive amount of work! I'll try to take an in depth view of the docker image tomorrow 😁

[JSzaszvari]

@geekgonecrazy @timkinnane

Thanks! Appreciate it.

Probably hold off testing till tomorrow as I've still got the last of the changes to merge. Ran out of time before work this morning, but will get the last of them up tonight.

Probably 90% through the rest of the outstanding items just ran out of time

[JSzaszvari]

• Support for loading scripts from an externally mounted volume with docker now works

• Custom NPM registry support has been added [WIP] Rebuild and Improve Docker Container #289

• Issue with CoffeeScript not loading with hubotv3 is sorted- Solved with a fix from Robot loadFile and parseHelp tests and method improvements hubotio/hubot#1378

[geekgonecrazy]

Maybe we can drop Dockerfile to root to dedup package.json?

Then just include the bashscript from sub folder?

[geekgonecrazy]

Can we dedup this some how? Having both places is going to make updating version and other dependencies harder

[JSzaszvari]

Agreed that's where I had it last night, but this goes into my question of having a separate repo.

Do we want to merge the adapter and docker image like it is now in this, I think it should be separate as the adapter is really a separate component

[JSzaszvari]

Forgot to add, Have updated this with those changes. Life is easier now ;)

[geekgonecrazy]

Do we need this since you do during image build?

[JSzaszvari]

2 reasons

This is to combat a really strange issue I was seeing where during build it was not installing 1 or 2 random dependencies . Tried with yarn and npm, no joy. The extra 5 seconds this takes to just make sure is worth it in my eyes

And

When people specify new scripts with the EXTERNAL_SCRIPTS env var those deps are not installed at build and will need to be installed. As most won't be building it merely deploying from docker hub

[JSzaszvari]

Actually, the EXTERNAL_SCRIPTS is done separately

Ignore that second reason

Mainly the first, happy to try again without it but was seeing really strange dep issues and added it in as a just in case

[jangmarker]

What is the progress on this? From my understanding this is still required and it looks pretty much done, doesn't it?

[JSzaszvari]

@jangmarker Apologies I will have this completed sometime within the next week. I had started but then had a family matter that I needed to attend too overseas.

I am back now and will finish it up next week.

[Thibugs]

Any update on the progress and an estimated date ? I'm actually stuck as we need to get the bot running on docker but the last release is too old.

[timkinnane]

@tgalloy This PR is functional and perfectly fine to merge as far as I know, but no one is currently maintaining this adapter. I would merge it myself but I don't have time to test it and be on hand if it causes problems from any current users.

If you're stuck, you could fork and continue from John's version https://github.com/JSzaszvari/hubot-rocketchat - Then if you find and resolve any issues, you can contribute them back here, or at least comment to give validation on this PR.

[eloo]

@timkinnane i've build an image based on johns PR and for now it still looks good 👍

[timkinnane]

@Sing-Li can you find anyone at RC to take over maintenance of hubot-rocketchat and approve this PR. @JSzaszvari did a fair amount of work last year and would be good to keep it. I actually used this PR as a base for the bBot boilerplate docker too and it's tidy work :D