Skip to content

fix(logger): replace PassThrough with Writable for log handling COMPASS-9736 #7222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Aug 26, 2025
Merged

fix(logger): replace PassThrough with Writable for log handling COMPASS-9736 #7222

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d952737
fix(logger): replace PassThrough with Writable for log handling CLOUD…
nbbeeken Aug 22, 2025
075a733
fix(logger): replace PassThrough with Writable for log handling CLOUD…
nbbeeken Aug 22, 2025
533f97a
test: synchronous log call
nbbeeken Aug 22, 2025
f039277
add events
syn-zhu Aug 22, 2025
85d9edd
Merge branch 'CLOUDP-332732' of https://github.com/mongodb-js/compass…
syn-zhu Aug 22, 2025
05dd5e5
add more logs
syn-zhu Aug 25, 2025
43838ce
remoce fields
syn-zhu Aug 25, 2025
8ea0ba3
Merge branch 'main' into CLOUDP-332732
syn-zhu Aug 25, 2025
2e3cb29
fix test
syn-zhu Aug 26, 2025
f24620d
fix logging test
syn-zhu Aug 26, 2025
bc4b214
remove flags
syn-zhu Aug 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions packages/compass-connections/src/stores/connections-store-redux.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1521,6 +1521,9 @@ const connectWithOptions = (
inflightConnection = (async () => {
const deviceAuthAbortController = new AbortController();

let cancelled = false;
let started = false;
let succeeded = false;
try {
if (
getCurrentConnectionStatus(getState(), connectionInfo.id) ===
Expand Down Expand Up @@ -1639,6 +1642,17 @@ const connectWithOptions = (
);
}

started = true;
log.info(
mongoLogId(1_001_000_005),
'Compass Connection Attempt Started',
'Connection attempt started',
{
clusterName: connectionInfo.atlasMetadata?.clusterName,
connectionId: connectionInfo.id,
}
);
Comment on lines +1639 to +1647
Copy link
Collaborator Author

@nbbeeken nbbeeken Aug 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@syn-zhu On line 1583, there is log 1_001_000_004 that carries the same info, is there a significance to this logs position over that one?

Copy link
Collaborator

@syn-zhu syn-zhu Aug 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

related to my response to your next comment: Our purpose for introducing these logs was to facilitate connection latency tracking with Sentry. Given that, I wanted to reduce the surface area to connection attempts that would actually be meaningful.


const connectionAttempt = createConnectionAttempt({
logger: log.unbound,
proxyOptions: proxyPreferenceToProxyOptions(
Expand All @@ -1659,6 +1673,16 @@ const connectWithOptions = (
// This is how connection attempt indicates that the connection was
// aborted
if (!dataService || connectionAttempt.isClosed()) {
cancelled = true;
log.info(
mongoLogId(1_001_000_007),
'Compass Connection Attempt Cancelled',
'Connection attempt cancelled',
{
clusterName: connectionInfo.atlasMetadata?.clusterName,
connectionId: connectionInfo.id,
}
);
dispatch({
type: ActionTypes.ConnectionAttemptCancelled,
connectionId: connectionInfo.id,
Expand Down Expand Up @@ -1825,6 +1849,7 @@ const connectWithOptions = (
connectionInfo
);

succeeded = true;
log.info(
mongoLogId(1_001_000_006),
'Compass Connection Attempt Succeeded',
Expand Down Expand Up @@ -1870,6 +1895,18 @@ const connectWithOptions = (
);
}
} catch (err) {
if (started && !succeeded && !cancelled) {
log.info(
mongoLogId(1_001_000_008),
'Compass Connection Attempt Failed',
'Connection attempt failed',
{
clusterName: connectionInfo.atlasMetadata?.clusterName,
connectionId: connectionInfo.id,
error: (err as Error).message,
}
);
}
dispatch(connectionAttemptError(connectionInfo, err));
} finally {
deviceAuthAbortController.abort();
Expand Down
Loading