Resolve all pending problems with the current Dredd hook template

[honzajavorek]

There are two main problems on the hook template, which exploded into far more complicated issues then they seemed to be:

• Aruba update
• Missing --port and --host support

Hook handler authors were trying to propose and contribute, but now it's getting complicated, stale, tangled together. I think no contributor will come and reintroduce order to things, we'll have to come and push things forward. I tried to untangle all the problems and I propose following 10 steps:

Update Aruba

1. Kill extraneous child processes with Aruba
   Update all existing hook repos with the latest changes in this template dredd-hooks-template#16 (comment)
   The test suite kills any process (including itself) if its path contains string 'dredd-hooks' (e.g. in dir name) dredd-hooks-template#6

2. Finish update of the template in Ruby hooks
   Update dependency: Aruba (2) dredd-hooks-ruby#31

3. Finish update of the template in Python hooks
   Update Aruba test suite to contain the latest changes dredd-hooks-python#28

4. Update the template itself with the changes
   Update all existing hook repos with the latest changes in this template dredd-hooks-template#16
   Update dependencies dredd-hooks-template#15

Add --port and --host

5. Implement trial and error behavior in Dredd when running the hook
   handler
   Dumb implementation for support --port and --host for hooks server #712 (comment)

6. Properly resolve hook handler arguments
   Dredd should pass hook files as absolute paths to a hook handler #742

7. Pass --port and --host to the hook handler
   Dumb implementation for support --port and --host for hooks server #712

8. Add test for --port and --host to the template
   Add test for configurable port dredd-hooks-template#17

Propagate changes

9. Propagate changes to all hook handlers
   Update all existing hook repos with the latest changes in this template dredd-hooks-template#16

10. Document the process for adding things to the template
    Document a process for updating this repo & propagating changes to all hook handlers dredd-hooks-template#19

[ddelnano]

😓 really dropped the ball on coming back to #712

[honzajavorek]

Current strategy, which includes apiaryio/dredd-hooks-template#23 as well:

• copy the template from Python hooks, so we avoid any changes (deleted files, upgraded Aruba, ...) made by Gonzalo in both the template and the Ruby hooks, pretend that Python is pseudo code
• make the tests pass for Python hooks in the CI of the template repo
• rewrite the test suite to Node.js, with Python examples kept intact, remove Ruby dependencies Rewrite the template to Node.js dredd-hooks-template#23
• write docs on how to install / develop / upgrade the template in the hook languages (dredd docs and readme) Document a process for updating this repo & propagating changes to all hook handlers dredd-hooks-template#19, have a Travis CI example
• should dredd be a dependency or devDependency of the template?
• publish the dredd-hooks-template package (sem rel)
• update http://dredd.org/en/latest/hooks/new-language.html
• update of the template in Ruby hooks
• update dependencies in Ruby hooks
• update of the template in Python hooks
• update dependencies in Python hooks
• add eslint to template
• add greenkeeper to template
• finish the rest of Resolve all pending problems with the current Dredd hook template #917 (this issue)

[honzajavorek]

@ddelnano I'm about to get back to #712 (comment) and I'm wondering... would following work as well?

• Dredd runs the hooks handler only with paths to hook files if port and host are set to the default values
• If port or host are set to non-default values, then --port, --host, or both are added as options to the hooks handler command
• In case the hooks handler crashes, Dredd will terminate, but will remember that port or host change was involved and will warn user with something like "hey, perhaps the hooks handler you're using doesn't support host / port change, so don't do that..."
• In case the hooks handler doesn't crash, but Dredd isn't able to connect, it will terminate, but will remember that port or host change was involved and will warn user with something like "hey, perhaps the hooks handler you're using doesn't support host / port change, so don't do that..."
• Otherwise business as usual

What do you think?

[ddelnano]

Sorry I was in the middle of moving and then went on vacation 🍹. That sounds like the best plan for rolling out this change.

[honzajavorek]

I did most of the dirty work needed here and there's a work in progress in #1421 to implement the actual --port forwarding in Dredd.

[lukaszwit]

Hi, I would like to ask if the work is going to be continued on this issue?