refactor(lumberjack): replace with util fn #1213

JAdshead · 2023-12-14T19:11:29Z

Description

This is almost a direct lift and shift from https://github.com/americanexpress/lumberjack/blob/main/src/monkeypatches/attachHttpsRequestSpy.js.
For simplicity i combined the attach http and https request spies into single function.

Motivation and Context

One App is now only using small part of Lumberjack. This will allow lumberjack to be deprecated.

How Has This Been Tested?

Test suite.

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?

JAdshead · 2023-12-14T19:13:15Z

src/server/utils/logging/setup.js

-// In Node.js v8 and earlier https.request internally called http.request, but this is changed in
-// later versions
-// https://github.com/nodejs/node/blob/v6.x/lib/https.js#L206
-// https://github.com/nodejs/node/blob/v8.x/lib/https.js#L239
-// https://github.com/nodejs/node/blob/v10.x/lib/https.js#L271
-if (Number.parseInt(/^v(\d+)/.exec(process.version)[1], 10) > 8) {
-  monkeypatches.attachHttpsRequestSpy(outgoingRequestSpy, outgoingRequestEndSpy);
-}
-monkeypatches.attachHttpRequestSpy(outgoingRequestSpy, outgoingRequestEndSpy);


this has been simplified as One App has long since dropped support for node 8

JAdshead · 2023-12-14T19:13:22Z

src/server/utils/logging/attachSpy.js

@@ -0,0 +1,47 @@
+/*


https://github.com/americanexpress/lumberjack/blob/main/src/monkeypatches/attachSpy.js

JAdshead · 2023-12-14T19:13:40Z

src/server/utils/logging/attachRequestSpies.js

+  };
+}
+
+export default function attachRequestSpies(requestSpy, socketCloseSpy) {


https://github.com/americanexpress/lumberjack/blob/main/src/monkeypatches/attachHttpRequestSpy.js

github-actions · 2023-12-14T19:14:07Z

Size Change: 0 B

Total Size: 712 kB

ℹ️ View Unchanged

Filename	Size
`./build/app/app.js`	164 kB
`./build/app/app~vendors.js`	411 kB
`./build/app/runtime.js`	7.07 kB
`./build/app/service-worker-client.js`	7.25 kB
`./build/app/vendors.js`	123 kB

_{compressed-size-action}

JAdshead · 2023-12-14T19:15:03Z

src/server/utils/logging/attachRequestSpies.js

+  attachSpy(https, 'request', httpSpy('https', requestSpy, socketCloseSpy));
+  attachSpy(http, 'request', httpSpy('http', requestSpy, socketCloseSpy));


this is the only change. instead of having a function for each attachment we have a single function for attaching both.

JAdshead · 2023-12-14T19:15:25Z

src/server/utils/logging/attachRequestSpies.js

+  return url.parse(url.format(buildUrlObject(options, defaultProtocol)));
+}
+
+function httpSpy(defaultProtocol, requestSpy, socketCloseSpy) {


https://github.com/americanexpress/lumberjack/blob/main/src/monkeypatches/httpSpy.js

src/server/utils/logging/attachRequestSpies.js

package.json

JAdshead · 2023-12-21T17:58:03Z

src/server/utils/logging/attachRequestSpies.js

+import attachSpy from './attachSpy';
+
+function buildUrlObject(options, defaultProtocol) {
+  // TODO: url.parse is deprecated, use new URL() instead


this change is beyond the scope of this PR

giulianok · 2023-12-22T17:13:49Z

src/server/utils/logging/attachRequestSpies.js

+  const urlObject = {
+    auth: options.auth,
+    hostname: options.hostname || options.host || 'localhost',
+    protocol,
+    port: options.port || (protocol === 'http:' ? 80 : 443),
+    hash: parsedPath.hash,
+    path: parsedPath.path,
+    pathname: parsedPath.pathname,
+    query: parsedPath.query,
+    search: parsedPath.search,
+  };
+  if (
+    (protocol === 'http:' && urlObject.port === 80)
+    || (protocol === 'https:' && urlObject.port === 443)
+  ) {
+    urlObject.port = undefined;
+  }
+  return urlObject;
+}


(ref #1213 (comment)), knowing that we can use undefined for port, then there's no need for the if statement + mutation, we could simplify it like:

Suggested change

const urlObject = {

auth: options.auth,

hostname: options.hostname || options.host || 'localhost',

protocol,

port: options.port || (protocol === 'http:' ? 80 : 443),

hash: parsedPath.hash,

path: parsedPath.path,

pathname: parsedPath.pathname,

query: parsedPath.query,

search: parsedPath.search,

};

if (

(protocol === 'http:' && urlObject.port === 80)

|| (protocol === 'https:' && urlObject.port === 443)

) {

urlObject.port = undefined;

}

return urlObject;

}

const urlObject = {

auth: options.auth,

hostname: options.hostname || options.host || 'localhost',

protocol,

portx: options.port || (protocol === 'http:' ? 80 : 443),

port: options.port && (

(protocol === 'http:' && options.port !== 80) ||

(protocol === 'https:' && options.port !== 443)

) ? options.port : undefined,

hash: parsedPath.hash,

path: parsedPath.path,

pathname: parsedPath.pathname,

query: parsedPath.query,

search: parsedPath.search,

};

return urlObject;

}

The idea is that, if the options.port is provided then we validate and make sure it's a different port (different than 80 for http and different than 443 for https), otherwise we just set it to undefined.

Not, this leads me to the following question, why do we need to unset the port for those cases? can't just use 80 for http since that's the provided port? looks like that we need it's just port: options.port

This is not quite the same result. if the protocol is undefined and no options.port is set the current result would be 443 not undefined. Im not convinced that this is the intended result but for this PR im trying to keep the functionality identical.

I think having the removal as a separate conditional is clearer. I suspect this logic is based around old Node edge cases.
This PR is intended as a simple lift and shift. This will need a rewrite as part of the removal url.parse

https://github.com/americanexpress/one-app/pull/1213/files#diff-8bfac20050e8adb94d26610e32b8af417528273ceb2d8e282e06484e02825299R25-R30

10xLaCroixDrinker · 2024-01-03T19:39:52Z

commit type should be refactor

JAdshead · 2024-01-03T20:17:34Z

commit type should be refactor

will change on merge

10xLaCroixDrinker · 2024-01-03T19:49:58Z

__tests__/server/utils/logging/attachRequestSpies.spec.js

+
+      const callOriginal = jest.fn(() => 'client request object');
+
+      httpsSpy(['http://example.tld'], callOriginal);


Can we call from http directly?

we could, these tests rely on attachSpy being mocked so they will all need a rewrite.

chore(lumberjack): replace with util fn

e839850

JAdshead requested review from a team as code owners December 14, 2023 19:11

github-actions bot added Feature one-app-team-review-requested labels Dec 14, 2023

JAdshead commented Dec 14, 2023

View reviewed changes

giulianok reviewed Dec 16, 2023

View reviewed changes

src/server/utils/logging/attachRequestSpies.js Outdated Show resolved Hide resolved

Matthew-Mallimo reviewed Dec 18, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

JAdshead added 3 commits December 21, 2023 08:50

chore(deps): remove lumberjack

d546271

fix(attachRequestSpies): remove slow delete

ec3c656

chore(attachRequestSpies): todo remove url.parse

a227f84

JAdshead commented Dec 21, 2023

View reviewed changes

JAdshead requested review from Matthew-Mallimo and giulianok December 21, 2023 17:58

giulianok suggested changes Dec 22, 2023

View reviewed changes

JAdshead added 2 commits January 3, 2024 10:55

Merge branch 'main' into feat/replace-lumberjac

c9cd3e1

Merge branch 'main' into feat/replace-lumberjac

a4f8afb

JAdshead requested review from giulianok and a team January 3, 2024 19:29

Merge branch 'main' into feat/replace-lumberjac

1867d75

Merge branch 'main' into feat/replace-lumberjac

bc4522f

JAdshead enabled auto-merge (squash) January 3, 2024 20:17

10xLaCroixDrinker changed the title ~~chore(lumberjack): replace with util fn~~ refactor(lumberjack): replace with util fn Jan 3, 2024

10xLaCroixDrinker reviewed Jan 4, 2024

View reviewed changes

Matthew-Mallimo previously approved these changes Jan 5, 2024

View reviewed changes

test(attachRequestSpies): call http request instead of mock

f3c5079

JAdshead dismissed Matthew-Mallimo’s stale review via f3c5079 January 5, 2024 21:53

JAdshead requested review from a team January 8, 2024 20:32

Matthew-Mallimo approved these changes Jan 11, 2024

View reviewed changes

10xLaCroixDrinker approved these changes Jan 11, 2024

View reviewed changes

giulianok approved these changes Jan 11, 2024

View reviewed changes

JAdshead merged commit 6f8c847 into main Jan 11, 2024
9 checks passed

JAdshead deleted the feat/replace-lumberjac branch January 11, 2024 19:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(lumberjack): replace with util fn #1213

refactor(lumberjack): replace with util fn #1213

JAdshead commented Dec 14, 2023

JAdshead Dec 14, 2023

JAdshead Dec 14, 2023

JAdshead Dec 14, 2023

github-actions bot commented Dec 14, 2023 •

edited

Loading

JAdshead Dec 14, 2023

JAdshead Dec 14, 2023

JAdshead Dec 21, 2023

giulianok Dec 22, 2023

JAdshead Jan 3, 2024 •

edited

Loading

10xLaCroixDrinker commented Jan 3, 2024

JAdshead commented Jan 3, 2024

10xLaCroixDrinker Jan 3, 2024

JAdshead Jan 5, 2024

JAdshead Jan 5, 2024

		attachSpy(https, 'request', httpSpy('https', requestSpy, socketCloseSpy));
		attachSpy(http, 'request', httpSpy('http', requestSpy, socketCloseSpy));


		const callOriginal = jest.fn(() => 'client request object');

		httpsSpy(['http://example.tld'], callOriginal);

refactor(lumberjack): replace with util fn #1213

refactor(lumberjack): replace with util fn #1213

Conversation

JAdshead commented Dec 14, 2023

Description

Motivation and Context

How Has This Been Tested?

Types of Changes

Checklist:

What is the Impact to Developers Using One App?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Dec 14, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JAdshead Jan 3, 2024 • edited Loading

Choose a reason for hiding this comment

10xLaCroixDrinker commented Jan 3, 2024

JAdshead commented Jan 3, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Dec 14, 2023 •

edited

Loading

JAdshead Jan 3, 2024 •

edited

Loading