Skip to content
This repository has been archived by the owner on Apr 24, 2024. It is now read-only.

Commit

Permalink
Merge pull request #133 from jmartin4563/NEWRELIC-5896-koa-mjs
Browse files Browse the repository at this point in the history
NEWRELIC-5896 Updated koa instrumentation to support ESM
  • Loading branch information
bizob2828 authored Dec 15, 2022
2 parents dc6f35f + 6fb19d6 commit ec39969
Show file tree
Hide file tree
Showing 7 changed files with 384 additions and 6 deletions.
11 changes: 10 additions & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
/*
* Copyright 2022 New Relic Corporation. All rights reserved.
* SPDX-License-Identifier: Apache-2.0
*/

'use strict'

module.exports = {
extends: '@newrelic'
extends: '@newrelic',
parserOptions: {
ecmaVersion: 2020
}
}
36 changes: 36 additions & 0 deletions THIRD_PARTY_NOTICES.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
* [newrelic](#newrelic)
* [prettier](#prettier)
* [semver](#semver)
* [sinon](#sinon)
* [tap](#tap)


Expand Down Expand Up @@ -1233,6 +1234,41 @@ IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
```

### sinon

This product includes source derived from [sinon](https://github.com/sinonjs/sinon) ([v15.0.1](https://github.com/sinonjs/sinon/tree/v15.0.1)), distributed under the [BSD-3-Clause License](https://github.com/sinonjs/sinon/blob/v15.0.1/LICENSE):

```
(The BSD License)
Copyright (c) 2010-2017, Christian Johansen, [email protected]
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of Christian Johansen nor the names of his contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
```

### tap

This product includes source derived from [tap](https://github.com/tapjs/node-tap) ([v16.0.1](https://github.com/tapjs/node-tap/tree/v16.0.1)), distributed under the [ISC License](https://github.com/tapjs/node-tap/blob/v16.0.1/LICENSE):
Expand Down
11 changes: 7 additions & 4 deletions lib/instrumentation.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@
const symbols = require('./symbols')

module.exports = function initialize(shim, Koa) {
if (!shim || !Koa || Object.keys(Koa.prototype).length > 1) {
// Koa's exports are different depending on using CJS or MJS - https://github.com/koajs/koa/issues/1513
const proto = Koa.prototype || Koa.default?.prototype

if (!shim || !Koa || !proto || Object.keys(proto).length > 1) {
shim.logger.debug(
'Koa instrumentation function called with incorrect arguments, not instrumenting.'
)
Expand All @@ -16,12 +19,12 @@ module.exports = function initialize(shim, Koa) {

shim.setFramework(shim.KOA)

shim.wrapMiddlewareMounter(Koa.prototype, 'use', wrapMiddleware)
shim.wrapReturn(Koa.prototype, 'createContext', wrapCreateContext)
shim.wrapMiddlewareMounter(proto, 'use', wrapMiddleware)
shim.wrapReturn(proto, 'createContext', wrapCreateContext)

// The application is used to handle unhandled errors in the application. We
// want to notice those.
shim.wrap(Koa.prototype, 'emit', function wrapper(shim, original) {
shim.wrap(proto, 'emit', function wrapper(shim, original) {
return function wrappedEmit(evt, err, ctx) {
if (evt === 'error' && ctx) {
shim.noticeError(ctx.req, err)
Expand Down
Loading

0 comments on commit ec39969

Please sign in to comment.