Hapi v17 Upgrade

The upgrade to v17 is a little involved. Below I've taken note of all the things that I believe impacts
the Kibana server application. Note that some of our components are actually already using v17 via
the hapi-latest dependency.

Useful links:

v17 Release Notes
Upgrade Guide
hapi-compat - Planning on setting this up before starting to help make the transition smooth
make-promises-safe - Would help by not letting the server crash if an await call throws

Plugins

All hapi plugin dependencies will need to be upgraded. Luckily, all have been updated to support Hapi v17:

vision
inert
h2o2
good / even-better
hapi-auth-cookie

We will also need to upgrade our Plugin interface in src/server/plugins/lib/plugin.js.

Async/Await

Need to update any Hapi framework calls that are using callbacks to use async/await.

server.auth.test() - 1 call
server.cache.provision() - 0
server.emit() - 0
server.initialize() - 0
server.inject() - 4 calls
server.register() - 4 calls
server.start() - 2 calls
server.stop() - 2 calls
Plugin register()
Any methods that previously had reply interface argument - ??
The after argument of server.dependency() - 0
Server methods - ??
Custom validation functions - ??
Cache methods and the generateFunc option - 0
The autoValue option of server.state() - 0

Remove `reply()` callback

All calls to the reply callback need to be replayed with simply returning and using the new h
response toolkit.

At first glance, this sounds pretty painful but it may actually be pretty simple. In most cases,
we should be able to change the reply argument to h in the request handler and then change the
reply(myHTML) call to return h.response(myHTML). The chaining interface is largely the same.

This also involves removing any calls to hold and send on response objects. In v17, we can
simply return when ready. I didn't find any usages of this pattern in our existing code base.

Rename `route.config` to `route.options`

route.config is now deprecated and will be removed in a future release. We should rename this key
to options in all server.route calls. This may be a bit tedious, but should be low-risk.

Set default auth strategy

We will need to specify the default strategy with a call to server.auth.default. Simple.

Upgrade hapi to v17 #13802

Description

Metadata

Metadata

Assignees

Labels

Type

Fields

Projects

Milestone

Relationships

Development

Issue actions