Skip to content

Give warning for deprecated clientId param #282

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 6 commits into from
Mar 12, 2025
Merged

Give warning for deprecated clientId param #282

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a35f468
renamed clientId to userAgentHeader in connect args
shivam2680 Feb 18, 2025
1e6bdf1
resolved conflicts
shivam2680 Feb 18, 2025
85a0e6d
addressed comments
shivam2680 Feb 19, 2025
94b2a9d
Merge remote-tracking branch 'origin/main' into add-clientId-warning
shivam2680 Feb 21, 2025
cfbbd6f
add warning for deprecated clientId param
shivam2680 Feb 21, 2025
2c90828
add backward compatibility
shivam2680 Mar 10, 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
8 changes: 8 additions & 0 deletions lib/DBSQLClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,14 @@ export default class DBSQLClient extends EventEmitter implements IDBSQLClient, I
* const session = client.connect({host, path, token});
*/
public async connect(options: ConnectionOptions, authProvider?: IAuthentication): Promise<IDBSQLClient> {
const deprecatedClientId = (options as any).clientId;
if (deprecatedClientId !== undefined) {
this.logger.log(
LogLevel.warn,
'Warning: The "clientId" option is deprecated. Please use "userAgentEntry" instead.',
);
}

Copy link
Collaborator

@jackyhu-db jackyhu-db Feb 21, 2025

Choose a reason for hiding this comment

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

can we assign it to userAgentEntry if it only give the warning.

Copy link
Contributor Author

@shivam2680 shivam2680 Feb 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

We can,
but the issue of sensitive info being passed through this param will persist.

Copy link
Collaborator

@jackyhu-db jackyhu-db Feb 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

can you try to redact it if it is service principal client id

this.authProvider = this.createAuthProvider(options, authProvider);

this.connectionProvider = this.createConnectionProvider(options);
Expand Down
19 changes: 19 additions & 0 deletions tests/unit/DBSQLClient.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,25 @@ describe('DBSQLClient.connect', () => {

expect(thriftConnectionStub.on.called).to.be.true;
});

it('should log a warning when deprecated clientId is passed', async () => {
const client = new DBSQLClient();
const logSpy = sinon.spy((client as any).logger, 'log');

const optionsWithDeprecated = {
...connectOptions,
clientId: 'clientId',
};

await client.connect(optionsWithDeprecated as any);

const warningRegex = /Warning: The "clientId" option is deprecated\. Please use "userAgentEntry" instead\./;
const callFound = logSpy.getCalls().some((call) => warningRegex.test(call.args[1]));

expect(callFound).to.be.true;

logSpy.restore();
});
});

describe('DBSQLClient.openSession', () => {
Expand Down
Loading