Skip to content

chore(data-service): use identifyServerName from mongodb-build-info COMPASS-9930 #7507

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 8 commits into from
Oct 31, 2025
Merged

chore(data-service): use identifyServerName from mongodb-build-info COMPASS-9930 #7507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f8c61c8
Bumped mongodb-build-info dependency
kraenhansen Oct 31, 2025
02bda77
Rename dbType to serverName
kraenhansen Oct 24, 2025
dd4a17f
Use identifyServerName instead of getGenuineMongoDB
kraenhansen Oct 24, 2025
f89f301
Handle "unknown" server names as genuine
kraenhansen Oct 27, 2025
2b11c54
Implement reusable useHasNonGenuineConnections hook
kraenhansen Oct 29, 2025
5fe10f1
Use useHasNonGenuineConnections hook in assistant drawer
kraenhansen Oct 29, 2025
6ab09ca
Use useHasNonGenuineConnections hook in assistant drawer
kraenhansen Oct 31, 2025
8fa3973
Call into mongodb-build-info when mocking the MockDataService
kraenhansen Oct 31, 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
1 change: 1 addition & 0 deletions configs/testing-library-compass/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
"@testing-library/react": "^12.1.5",
"@testing-library/react-hooks": "^7.0.2",
"@testing-library/user-event": "^13.5.0",
"mongodb-build-info": "^1.8.1",
"mongodb-connection-string-url": "^3.0.1",
"react": "^17.0.2",
"react-redux": "^8.1.3",
Expand Down
26 changes: 19 additions & 7 deletions configs/testing-library-compass/src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ import type {
DataService,
InstanceDetails,
} from 'mongodb-data-service';
import { identifyServerName } from 'mongodb-build-info';
import Sinon from 'sinon';
import React from 'react';
import type {
Expand Down Expand Up @@ -175,8 +176,22 @@ export class MockDataService
disconnect(): Promise<void> {
return Promise.resolve();
}
instance(): Promise<InstanceDetails> {
return Promise.resolve({
async instance(): Promise<InstanceDetails> {
const { connectionString } = this.connectionOptions;
const serverName = await identifyServerName({
connectionString,
adminCommand: () =>
Promise.reject(
new Error(
'MockDataService adminCommand: this is a mocked environment; no server commands available.'
)
),
});
const genuineMongoDB = {
serverName,
isGenuine: serverName === 'mongodb' || serverName === 'unknown',
};
return {
auth: {
user: null,
roles: [],
Expand All @@ -188,10 +203,7 @@ export class MockDataService
version: '100.0.0',
},
host: {},
genuineMongoDB: {
isGenuine: true,
dbType: 'mongodb',
},
genuineMongoDB,
dataLake: {
isDataLake: false,
version: null,
Expand All @@ -200,7 +212,7 @@ export class MockDataService
isAtlas: false,
isLocalAtlas: false,
csfleMode: 'unavailable',
});
};
}
}

Expand Down
94 changes: 74 additions & 20 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 41 additions & 0 deletions packages/compass-app-stores/src/provider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import type { MongoDBInstanceProps } from 'mongodb-instance-model';
import { MongoDBInstance } from 'mongodb-instance-model';
import React, {
createContext,
useCallback,
useContext,
useEffect,
useMemo,
Expand Down Expand Up @@ -93,6 +94,46 @@ export const mongoDBInstanceLocator = createServiceLocator(
'mongoDBInstanceLocator'
);

/**
* Hook to check if there are any connected non-genuine MongoDB connections.
* @return true if any connected connection is to a non-genuine MongoDB server.
*/
export function useHasNonGenuineConnections(): boolean {
const instancesManager = useContext(MongoDBInstancesManagerContext);

const hasNonGenuineConnections = useCallback(
function () {
if (!instancesManager) {
return false;
}
return Array.from(instancesManager.listMongoDBInstances().values()).some(
(instance) => {
return !instance.genuineMongoDB.isGenuine;
}
);
},
[instancesManager]
);

const [result, setResult] = useState(hasNonGenuineConnections);

useEffect(() => {
if (instancesManager) {
const updateResult = () => {
setResult(hasNonGenuineConnections);
};
instancesManager.on('instance-started', updateResult);
instancesManager.on('instance-removed', updateResult);
return () => {
instancesManager.off('instance-started', updateResult);
instancesManager.off('instance-removed', updateResult);
};
}
}, [instancesManager, setResult, hasNonGenuineConnections]);
Comment on lines +118 to +132
Copy link

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

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

The hasNonGenuineConnections function is included in the useEffect dependency array, which will cause the effect to re-run every render since it's recreated each time. Consider removing it from the dependencies or memoizing the function with useCallback.

Suggested change
const [result, setResult] = useState(hasNonGenuineConnections);
useEffect(() => {
if (instancesManager) {
const updateResult = () => {
setResult(hasNonGenuineConnections);
};
instancesManager.on('instance-started', updateResult);
instancesManager.on('instance-removed', updateResult);
return () => {
instancesManager.off('instance-started', updateResult);
instancesManager.off('instance-removed', updateResult);
};
}
}, [instancesManager, setResult, hasNonGenuineConnections]);
const [result, setResult] = useState(() => hasNonGenuineConnections());
useEffect(() => {
if (instancesManager) {
const updateResult = () => {
setResult(hasNonGenuineConnections());
};
instancesManager.on('instance-started', updateResult);
instancesManager.on('instance-removed', updateResult);
// Set initial value in case the event hasn't fired yet
updateResult();
return () => {
instancesManager.off('instance-started', updateResult);
instancesManager.off('instance-removed', updateResult);
};
}
}, [instancesManager]);

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

@kraenhansen kraenhansen Oct 31, 2025

Choose a reason for hiding this comment

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

@copilot it's already wrapped in useCallback? 🙃


return result;
}

const NamespaceModelContext = React.createContext<Database | Collection | null>(
null
);
Expand Down
2 changes: 1 addition & 1 deletion packages/compass-connections-navigation/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
"@mongodb-js/connection-form": "^1.72.1",
"@mongodb-js/connection-info": "^0.22.0",
"compass-preferences-model": "^2.64.0",
"mongodb-build-info": "^1.7.2",
"mongodb-build-info": "^1.8.1",
"react": "^17.0.2",
"react-virtualized-auto-sizer": "^1.0.6",
"react-window": "^1.8.6"
Expand Down
2 changes: 1 addition & 1 deletion packages/compass-connections/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
"compass-preferences-model": "^2.64.0",
"lodash": "^4.17.21",
"mongodb": "^6.19.0",
"mongodb-build-info": "^1.7.2",
"mongodb-build-info": "^1.8.1",
"mongodb-connection-string-url": "^3.0.1",
"mongodb-data-service": "^22.34.6",
"react": "^17.0.2",
Expand Down
Loading