Fastify sdk contrib (#523)

* Add fastify plugin skeleton

* Add fastify x-ray plugin

* Add test for request types

* Add test for request types

* Use the middleware configuration within the plugin

* Complete test plugin assertion

* Add test for setup section

* Add mandatory segment name

* Remove unused next value

* Export plugin as default

* Split plugin to use a hook and configure

* Update test to use request segment

* Add test to split headers

* Add test for resolveName

* Add test to create a new segment

* Add test for http property

* Add on response and error hooks

* Add test for error statuses

* Add test for ok status response

* Remove unused variable

* Fix hook segment assert

* Verify whether http is defined

* Update copy for fastify readme

* Restore lockversion to version 1

* Remove unused files

* Update to version 3.3.7

* Remove unused variable

* Update notice.txt

* Move dev dependency from package

* Update package lock

* Update package lock using lerna bootstrap

* Revert package-lock

* Update peer dependency

* Fix package-lock

Author: jorgevrgs

package-lock.json

@@ -34,6 +34,8 @@
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.1",
     "express": "^4.16.4",
+    "fastify": "^3.29.0",
+    "fastify-plugin": "^4.2.0",
     "grunt": "^1.0.4",
     "grunt-contrib-clean": "^1.0.0",
     "grunt-jsdoc": "^2.4.0",
@@ -58,6 +60,7 @@
     "aws-xray-sdk": "file:packages/full_sdk",
     "aws-xray-sdk-core": "file:packages/core",
     "aws-xray-sdk-express": "file:packages/express",
+    "aws-xray-sdk-fastify": "file:sdk_contrib/fastify",
     "aws-xray-sdk-hapi": "file:sdk_contrib/hapi",
     "aws-xray-sdk-koa2": "file:sdk_contrib/koa",
     "aws-xray-sdk-mysql": "file:packages/mysql",

package.json

@@ -0,0 +1 @@
+index.*

sdk_contrib/fastify/.eslintignore

@@ -0,0 +1,3 @@
+{
+    "extends": "../../.eslintrc.json"
+}

sdk_contrib/fastify/.eslintrc.json

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sdk_contrib/fastify/LICENSE

@@ -0,0 +1,5 @@
+AWS X-Ray SDK Fastify for JavaScript
+Copyright 2012-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+This product includes software developed at
+Amazon Web Services, Inc. (http://aws.amazon.com/).

sdk_contrib/fastify/NOTICE.txt

@@ -0,0 +1,78 @@
+# fastify-xray
+
+A Fastify plugin to log requests and subsegments through AWSXray.
+
+## Setup
+
+The plugin relies on the AWS credentials being set before being registered, or it will pull them from
+`~/.aws/credentials` as per the SDK default.
+
+For more details on using X-Ray, see the [docs](https://docs.aws.amazon.com/xray-sdk-for-nodejs/latest/reference)
+
+## Usage
+
+Simply register as a normal Fastify plugin
+
+```js
+const AWSXRay = require('aws-xray-sdk');
+
+await server.register(require('aws-xray-sdk-fastify'), {
+  segmentName: 'test segment',
+  captureAWS: true,
+  plugins: [AWSXRay.plugins.ECSPlugin],
+});
+```
+
+In automatic mode, you can access the X-Ray segment at any time via the AWSXRay SDK:
+
+```js
+const AWSXRay = require('aws-xray-sdk-core');
+
+const segment = AWSXRay.getSegment();
+segment.addAnnotation('hitController', 'true');
+```
+
+In manual mode, you can access the current X-Ray segment from the request object:
+
+```js
+server.route({
+  method: 'GET',
+  path: '/items',
+  handler: async (request, reply) => {
+    const segment = request.segment;
+    segment.addAnnotation('hitController', 'true');
+
+    return {};
+  },
+});
+```
+
+### Options
+
+- `segmentName` Segment name to use in place of default segment name generator (**required**)
+- `automaticMode` Specifies that X-Ray automatic mode is in use (default true)
+- `plugins` An array of AWS plugins to use (i.e. `[AWSXRay.plugins.EC2Plugin]`)
+- `captureAWS` Enables AWS X-Ray to capture AWS calls. This requires having `aws-sdk` installed as a peer dependency
+- `captureHTTP` Enables AWS X-Ray to capture all http calls
+- `capturePromises` Enables AWS X-Ray to capture all promises
+- `logger` Bind AWS X-Ray to compatible logging interface `({ trace, debug, info })`
+
+## Sample App
+
+A naive Fastify server with X-Ray enabled is available in the "sample" directory.
+The sample can be started from the sdk_contrib/fastify directory with: `npm run sample`
+
+Once running, a "hello world" GET endpoint will be available at `http://localhost:3010/`
+
+The sample will run but throw errors connecting to X-Ray if a local X-Ray daemon is not running.
+
+For more information on running the XRay daemon locally:
+https://docs.aws.amazon.com/xray/latest/devguide/xray-daemon-local.html
+
+## Thanks
+
+Based on the hard work @[AWS X-Ray Express Middleware](https://github.com/aws/aws-xray-sdk-node/tree/master/packages/express) and heavily inspired by [X-Ray Hapi](https://github.com/aws/aws-xray-sdk-node/tree/master/sdk_contrib/hapi)
+
+## Contributors
+
+- [Jorge Vargas](https://github.com/jorgevrgs)

sdk_contrib/fastify/README.md

@@ -0,0 +1,18 @@
+const AWSXRay = require('aws-xray-sdk-core');
+const { middleware: mwUtils } = AWSXRay;
+
+/** @type {import('fastify').onErrorHookHandler} */
+module.exports = function onErrorHook(request, reply, error, done) {
+  const { segment } = request;
+
+  if (segment) {
+    segment.addError(error);
+    mwUtils.middlewareLog(
+      'Fastify XRay segment encountered an error',
+      request.url,
+      segment
+    );
+  }
+
+  done();
+};

sdk_contrib/fastify/lib/hooks/on-error.hook.js

@@ -0,0 +1,31 @@
+// @ts-check
+const AWSXRay = require('aws-xray-sdk-core');
+const { middleware: mwUtils } = AWSXRay;
+
+/** @type {import('fastify').onRequestHookHandler} */
+module.exports = function onRequestHook(request, reply, done) {
+  const req = request.raw;
+  const res = reply.raw;
+
+  const segment = mwUtils.traceRequestResponseCycle(req, res);
+
+  if (AWSXRay.isAutomaticMode()) {
+    const ns = AWSXRay.getNamespace();
+    ns.bindEmitter(req);
+    ns.bindEmitter(res);
+
+    ns.run(() => {
+      AWSXRay.setSegment(segment);
+    });
+  } else {
+    request.log.info('Manual mode, skipping segment');
+
+    if (!request.segment) {
+      request.segment = segment;
+    } else {
+      request.log.warn('Request already has a segment, skipping');
+    }
+  }
+
+  done();
+};