refactor: migrating metrics server to Fastify #803

giulianok · 2022-08-10T16:04:26Z

Migrating Metrics Server from ExpressJS to Fastify

Description

This PR includes the migration of Metrics Server routes to Fastify + converting logging middleware into a fastify plugin

Metrics Server

All routes have been moved to Fastify

Logging

The logging middleware has been converted into a Fastify plugin. It required some refactoring in order to leverage fastify hooks.

To calculate ttfb (time to first byte), instead of monkey patching writeHead function from the raw/nodejs response, I leveraged the onSend fastify hook which is called right before writeHead is called, providing the same time (technically isn't the same but we are using Math.round when logging, so "it's the same").

Besides logging the full request duration and ttfb, I also added extra timers to calculate things like how long it took to start resolving a route, how long it took to resolved a route handler, etc.

Here's an example of a request that's taking 500ms to resolve things before fastify can start resolving the route handler, and the route handler takes 1000ms to resolved.

I achieved this by adding a sleep function to create the delay

These are real metrics from /metrics and /im-up, where we can see that /im-up is a bit slower because of the healthcheck fn

/metrics

/im-up

As we can see, we do not have an overhead on the request (pre route handler) and on the response builder

Motivation and Context

Allows us to run Metrics Server in Fastify without the need of Express

How Has This Been Tested?

Types of Changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation (adding or updating documentation)
Dependency update
Security update

Checklist:

My change requires a change to the documentation and I have updated the documentation accordingly.
These changes should be applied to a maintenance branch.
This change requires cross browser checks.
Performance tests should be ran against the server prior to merging.
This change impacts caching for client browsers.
This change impacts HTTP headers.
This change adds additional environment variable requirements for One App users.
I have added the Apache 2.0 license header to any new files created.

What is the Impact to Developers Using One App?

BREAKING CHANGE: Upgrade from React 16 to 17

BREAKING CHANGE: minimum supported node version is 16

* chore(babel): update packages * chore(commitlint): update * chore(rollup-plugins): update * chore(acorn): uninstall * chore(babel-preset-amex): update to 4 * chore(body-parser): update * chore(dev-deps): update * chore(holocron): update 1.3.0 * chore(redux): update 4.2.0 * chore(core-js): update 3.23.3 * chore(deps): run npm update * chore(husky): update to 8.x * chore(chalk): downgrade to non esm version * chore(webdriverio): update 7.x * feat(dockerfile): update node version to 16.15.1 * chore(deps): update supertest * fix(node): set min version 16.15.1 * chore(deps): dedupe * test(createRequestHtmlFragment): more reliable error message * chore(jest): upgrade 28.1.2

BREAKING CHANGE: Upgrade from React 16 to 17

BREAKING CHANGE: minimum supported node version is 16

* chore(babel): update packages * chore(commitlint): update * chore(rollup-plugins): update * chore(acorn): uninstall * chore(babel-preset-amex): update to 4 * chore(body-parser): update * chore(dev-deps): update * chore(holocron): update 1.3.0 * chore(redux): update 4.2.0 * chore(core-js): update 3.23.3 * chore(deps): run npm update * chore(husky): update to 8.x * chore(chalk): downgrade to non esm version * chore(webdriverio): update 7.x * feat(dockerfile): update node version to 16.15.1 * chore(deps): update supertest * fix(node): set min version 16.15.1 * chore(deps): dedupe * test(createRequestHtmlFragment): more reliable error message * chore(jest): upgrade 28.1.2

github-actions · 2022-08-10T16:07:24Z

Size Change: -299 B (0%)

Total Size: 680 kB

Filename	Size	Change
`./build/app/vendors.js`	114 kB	-299 B (0%)

ℹ️ View Unchanged

Filename	Size
`./build/app/app.js`	165 kB
`./build/app/app~vendors.js`	386 kB
`./build/app/runtime.js`	7.07 kB
`./build/app/service-worker-client.js`	7.26 kB

_{compressed-size-action}

src/server/plugins/healthCheck.js

giulianok · 2022-08-16T14:18:16Z

src/server/utils/logging/fastifyPlugin.js

+};
+
+const getLocale = (req) => {
+  // TODO: Verify if `store` is available


this only affects the locale in logger

this is not longer a blocker, the Metrics Server does not inject the store, only the SSR Server which is being migrated in a separate PR

JAdshead · 2022-08-16T15:09:57Z

src/server/metricsServer.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 American Express Travel Related Services Company, Inc.
+ * Copyright 2022 American Express Travel Related Services Company, Inc.


years in existing files can stay the same

JAdshead · 2022-08-16T15:17:12Z

src/server/metricsServer.js

+  });
+  await fastify.register(fp(logging));
+  await fastify.register(helmet);
+  await fastify.register(healthCheck);


i'm not sold on having the route abstracted into the plugin. I would have to do into each plugin to understand what routes this serves. can you provide your reasoning ?

that's true. We could pass the url through the options but still hides the route. Best option would be to create a reply decorator so we can implement the route outside the plugin

JAdshead · 2022-08-16T15:20:51Z

src/server/ssrServer.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 American Express Travel Related Services Company, Inc.
+ * Copyright 2022 American Express Travel Related Services Company, Inc.


this can be reverted

JAdshead · 2022-08-16T15:21:11Z

src/server/utils/logging/fastifyPlugin.js

@@ -0,0 +1,179 @@
+/*
+ * Copyright 2019 American Express Travel Related Services Company, Inc.


new file so should be this year.

Suggested change

* Copyright 2019 American Express Travel Related Services Company, Inc.

* Copyright 2022 American Express Travel Related Services Company, Inc.

JAdshead · 2022-08-16T15:56:00Z

src/server/utils/logging/fastifyPlugin.js

+export const $RouteHandler = Symbol('$RouteHandler');
+export const $ResponseBuilder = Symbol('$ResponseBuilder');
+
+const TIMERS = {};


Could one instance of this be shared across multiple requests ?

just looking through the code, this is not really needed, i'll remove it

src/server/utils/logging/fastifyPlugin.js

__tests__/server/plugins/healthCheck.spec.js

__tests__/server/ssrServer.spec.js

10xLaCroixDrinker and others added 27 commits June 28, 2022 15:49

feat(deps): upgrade to react 17

810d3a8

BREAKING CHANGE: Upgrade from React 16 to 17

feat(server): drop node 12 support

de26826

BREAKING CHANGE: minimum supported node version is 16

test(modules): fix dep resolution error

b5693a1

chore(release): 6.0.0-rc.0

2b618cf

Merge branch 'main' into feature/v6

a92f3f7

chore(bundle-size-action): wider strip-hash capture

72e09de

fix(helmet): disable breaking headers (#780)

9cf7b0c

feat(deps): upgrade to react 17

036bc44

BREAKING CHANGE: Upgrade from React 16 to 17

feat(server): drop node 12 support

bdb0364

BREAKING CHANGE: minimum supported node version is 16

test(modules): fix dep resolution error

3e1ac86

chore(release): 6.0.0-rc.0

b79e2c5

chore(bundle-size-action): wider strip-hash capture

162282c

fix(helmet): disable breaking headers (#780)

7fd51d7

chore(changelog): correct 5.15.0

55fa6ef

feat: running app through fastify

202e6ba

chore: merge conflicts

778bac0

chore: fixing unit tests

c2e0f0d

chore: fixed unit testing

9e22979

fix: tests

b784ede

chore: merge conflicts

64583c5

chore: minor start server code improvement

5db500a

feat: added rate limiter in metrics api

f1d9041

chore: minor adjustments

cd20f13

feat: metrics server fastify migration

80da58d

refactor: migrated logging middleware to fastify as plugin

f57538b

github-actions bot added refactor one-app-team-review-requested labels Aug 10, 2022

chore: merge conflicts

5c9b6c2

github-advanced-security bot found potential problems Aug 11, 2022

View reviewed changes

src/server/plugins/healthCheck.js Fixed Show fixed Hide fixed

giulianok added 2 commits August 15, 2022 21:27

test: added missing test for coverage

0bf49f8

refactor: added rate limit plugin

f40e96d

giulianok marked this pull request as ready for review August 16, 2022 14:13

giulianok requested review from a team as code owners August 16, 2022 14:13

giulianok changed the title ~~refactor: migrating metrics server to Fastify~~ [DO NOT MERGE] refactor: migrating metrics server to Fastify Aug 16, 2022

giulianok commented Aug 16, 2022

View reviewed changes

JAdshead reviewed Aug 16, 2022

View reviewed changes

giulianok added 2 commits August 17, 2022 11:33

refactor: converted hardcoded route into decorator

44c0004

refactor: removed health check middleware

899af07

giulianok changed the title ~~[DO NOT MERGE] refactor: migrating metrics server to Fastify~~ refactor: migrating metrics server to Fastify Aug 17, 2022

giulianok requested review from JAdshead and a team August 17, 2022 15:45

Merge branch 'main' into refactor/ONE-8301-metrics-fastify-migration

4f159a7

10xLaCroixDrinker reviewed Aug 25, 2022

View reviewed changes

chore: feedback

65dfef4

giulianok requested a review from 10xLaCroixDrinker August 30, 2022 20:27

JAdshead requested review from a team August 30, 2022 22:20

10xLaCroixDrinker approved these changes Aug 31, 2022

View reviewed changes

Merge branch 'main' into refactor/ONE-8301-metrics-fastify-migration

a4dc2c1

JAdshead approved these changes Sep 2, 2022

View reviewed changes

giulianok merged commit a0fc9ed into main Sep 2, 2022

giulianok deleted the refactor/ONE-8301-metrics-fastify-migration branch September 2, 2022 00:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: migrating metrics server to Fastify #803

refactor: migrating metrics server to Fastify #803

giulianok commented Aug 10, 2022 •

edited

Loading

github-actions bot commented Aug 10, 2022 •

edited

Loading

giulianok Aug 16, 2022

giulianok Aug 17, 2022

JAdshead Aug 16, 2022

JAdshead Aug 16, 2022 •

edited

Loading

giulianok Aug 17, 2022

JAdshead Aug 16, 2022

JAdshead Aug 16, 2022

JAdshead Aug 16, 2022 •

edited

Loading

giulianok Aug 17, 2022

		@@ -0,0 +1,179 @@
		/*
		* Copyright 2019 American Express Travel Related Services Company, Inc.

	* Copyright 2019 American Express Travel Related Services Company, Inc.
	* Copyright 2022 American Express Travel Related Services Company, Inc.

refactor: migrating metrics server to Fastify #803

refactor: migrating metrics server to Fastify #803

Conversation

giulianok commented Aug 10, 2022 • edited Loading

Description

Metrics Server

Logging

Motivation and Context

How Has This Been Tested?

Types of Changes

Checklist:

What is the Impact to Developers Using One App?

github-actions bot commented Aug 10, 2022 • edited Loading

giulianok Aug 16, 2022

Choose a reason for hiding this comment

giulianok Aug 17, 2022

Choose a reason for hiding this comment

JAdshead Aug 16, 2022

Choose a reason for hiding this comment

JAdshead Aug 16, 2022 • edited Loading

Choose a reason for hiding this comment

giulianok Aug 17, 2022

Choose a reason for hiding this comment

JAdshead Aug 16, 2022

Choose a reason for hiding this comment

JAdshead Aug 16, 2022

Choose a reason for hiding this comment

JAdshead Aug 16, 2022 • edited Loading

Choose a reason for hiding this comment

giulianok Aug 17, 2022

Choose a reason for hiding this comment

giulianok commented Aug 10, 2022 •

edited

Loading

github-actions bot commented Aug 10, 2022 •

edited

Loading

JAdshead Aug 16, 2022 •

edited

Loading

JAdshead Aug 16, 2022 •

edited

Loading