feat: Hapi auto-instrumentation

[carolinee21]

Which problem is this PR solving?

• Fixes Plugin for Hapi #92
• Adds automatic instrumentation for Hapi, a Node.js web framework.

Short description of the changes

• This instrumentation provides automatic tracing for hapi server routes and (request lifecycle extensions)[https://github.com/hapijs/hapi/blob/master/API.md#request-lifecycle] defined either directly or via a Hapi plugin.

• Some example traces are shown here:

• User friendly example code is also added under examples/hapi

• A visual diagram of the structure of this new instrumentation is provided here:
  

• Note: this build is currently affected by the compilation errors which will be fixed via fix: various compilation errors #170

[carolinee21]

@dyladan @obecny If someone could please add the tag "Internship Ending Soon" tag and add a requested review from @open-telemetry/javascript-maintainers, that would be great!

[codecov]

Codecov Report

Merging #171 into master will increase coverage by 0.62%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #171      +/-   ##
==========================================
+ Coverage   94.61%   95.23%   +0.62%     
==========================================
  Files          84       93       +9     
  Lines        4124     4767     +643     
  Branches      432      493      +61     
==========================================
+ Hits         3902     4540     +638     
- Misses        222      227       +5     

Impacted Files	Coverage Δ
...de/opentelemetry-hapi-instrumentation/src/utils.ts	100.00% <0.00%> (ø)
...entelemetry-hapi-instrumentation/test/hapi.test.ts	100.00% <0.00%> (ø)
...de/opentelemetry-hapi-instrumentation/src/types.ts	100.00% <0.00%> (ø)
...de/opentelemetry-hapi-instrumentation/.eslintrc.js	0.00% <0.00%> (ø)
...ode/opentelemetry-hapi-instrumentation/.mocharc.js	60.00% <0.00%> (ø)
...ode/opentelemetry-hapi-instrumentation/src/hapi.ts	98.43% <0.00%> (ø)
.../opentelemetry-hapi-instrumentation/src/version.ts	100.00% <0.00%> (ø)
...etry-hapi-instrumentation/test/hapi-plugin.test.ts	100.00% <0.00%> (ø)
...-hapi-instrumentation/test/hapi-server-ext.test.ts	100.00% <0.00%> (ø)

[carolinee21]

Hapi itself is incompatible with Node versions <12.x.x, so the builds using node8 and node10 are expected to fail. Is there a recommended way to handle this and update the CircleCI config so it just checks node12 (and node14 if possible)?

[dyladan]

Is there a recommended way to handle this and update the CircleCI config so it just checks node12 (and node14 if possible)?

This would be done directly in the .test.ts files.

For an example of how to skip a test you can look at mysql/pg/mongo which are skipped during normal operation. It goes something like this:

describe('this suite only runs in node 12+', () => {
  if (!semver.satisfies(process.version, '>=12.0.0')) {
    this.skip();
  }

  it('this test is skipped in node 10', () => {});
});

[carolinee21]

This would be done directly in the .test.ts files.

Okay, thank you for the response, I'll add that now!

[dyladan]

2952602 seems to work, but is there some reason you decided to do it in the mocha config rather than in the tests like I suggested? I'm not saying your approach is worse, just interested in why you decided to do it that way.

[carolinee21]

2952602 seems to work, but is there some reason you decided to do it in the mocha config rather than in the tests like I suggested? I'm not saying your approach is worse, just interested in why you decided to do it that way.

@dyladan Yes, there is! The build failure earlier was happening when the Hapi module was imported at the top of each test file, so it was still failing when I tried skipping the individual tests. With the mocha config, it checks the node version before loading any of the test files, so it doesn't run into the same build issues.

[vmarchaud]

🚀

[dyladan]

This looks great @carolinee21 thanks for the contribution