-
Notifications
You must be signed in to change notification settings - Fork 12
Add headers support for MongoDB Atlas API v2 compatibility #60
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.
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
Draft
Copilot
wants to merge
3
commits into
master
Choose a base branch
from
copilot/fix-58
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| const {describe, it, afterEach, before, beforeEach} = exports.lab = require("@hapi/lab").script(); | ||
| const {expect} = require('@hapi/code'); | ||
| const getClient = require('../src/index.js'); | ||
| const HttpClient = require('../src/httpClient.js'); | ||
| const {stub} = require("sinon"); | ||
| const {MockAgent, setGlobalDispatcher} = require('urllib'); | ||
|
|
||
| const baseUrl = "http://localhost:7001"; | ||
| const projectId = "dummyProjectId"; | ||
|
|
||
| describe("Mongo Atlas Api Client - Headers Support", () => { | ||
|
|
||
| let mockAgent; | ||
| let mockPool; | ||
| before(() => { | ||
| mockAgent = new MockAgent(); | ||
| setGlobalDispatcher(mockAgent); | ||
| }); | ||
|
|
||
| beforeEach(() => { | ||
| mockPool = mockAgent.get(baseUrl); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| mockAgent.assertNoPendingInterceptors(); | ||
| }); | ||
|
|
||
| describe("When client is created with custom headers", () => { | ||
|
|
||
| it("should include custom headers in requests", async () => { | ||
| const customHeaders = {"Accept": "application/vnd.atlas.2025-03-12+json"}; | ||
| const client = getClient({ | ||
| "publicKey": "dummuyPublicKey", | ||
| "privateKey": "dummyPrivateKey", | ||
| "baseUrl": baseUrl, | ||
| "projectId": projectId, | ||
| "headers": customHeaders | ||
| }); | ||
|
|
||
| mockPool.intercept({ | ||
| "path": `/groups/${projectId}/databaseUsers/admin/myUsername?key1=value1`, | ||
| "method": "get", | ||
| "headers": { | ||
| "Accept": "application/vnd.atlas.2025-03-12+json" | ||
| } | ||
| }) | ||
| .reply(200, {"user": "data"}); | ||
|
|
||
| const result = await client.user.get("myUsername", {"key1": "value1"}); | ||
| expect(result).to.equal({"user": "data"}); | ||
| }); | ||
|
|
||
| it("should work with empty headers object", async () => { | ||
| const client = getClient({ | ||
| "publicKey": "dummuyPublicKey", | ||
| "privateKey": "dummyPrivateKey", | ||
| "baseUrl": baseUrl, | ||
| "projectId": projectId, | ||
| "headers": {} | ||
| }); | ||
|
|
||
| mockPool.intercept({ | ||
| "path": `/groups/${projectId}/databaseUsers/admin/myUsername`, | ||
| "method": "get" | ||
| }) | ||
| .reply(200, {"user": "data"}); | ||
|
|
||
| const result = await client.user.get("myUsername"); | ||
| expect(result).to.equal({"user": "data"}); | ||
| }); | ||
|
|
||
| it("should work without headers property", async () => { | ||
| const client = getClient({ | ||
| "publicKey": "dummuyPublicKey", | ||
| "privateKey": "dummyPrivateKey", | ||
| "baseUrl": baseUrl, | ||
| "projectId": projectId | ||
| }); | ||
|
|
||
| mockPool.intercept({ | ||
| "path": `/groups/${projectId}/databaseUsers/admin/myUsername`, | ||
| "method": "get" | ||
| }) | ||
| .reply(200, {"user": "data"}); | ||
|
|
||
| const result = await client.user.get("myUsername"); | ||
| expect(result).to.equal({"user": "data"}); | ||
| }); | ||
|
|
||
| it("should merge custom headers with method-specific headers", async () => { | ||
| const customHeaders = {"Accept": "application/vnd.atlas.2025-03-12+json"}; | ||
| const client = getClient({ | ||
| "publicKey": "dummuyPublicKey", | ||
| "privateKey": "dummyPrivateKey", | ||
| "baseUrl": baseUrl, | ||
| "projectId": projectId, | ||
| "headers": customHeaders | ||
| }); | ||
|
|
||
| mockPool.intercept({ | ||
| "path": `/groups/${projectId}/databaseUsers?key1=value1`, | ||
| "method": "POST", | ||
| "data": {"username": "testUser"}, | ||
| "headers": { | ||
| "Accept": "application/vnd.atlas.2025-03-12+json", | ||
| "Content-Type": "application/json" | ||
| } | ||
| }) | ||
| .reply(200, {"user": "created"}); | ||
|
|
||
| const result = await client.user.create({"username": "testUser"}, {"key1": "value1"}); | ||
| expect(result).to.equal({"user": "created"}); | ||
| }); | ||
|
|
||
| it("should merge custom headers with httpOptions headers", async () => { | ||
| const customHeaders = {"Accept": "application/vnd.atlas.2025-03-12+json"}; | ||
| const client = getClient({ | ||
| "publicKey": "dummuyPublicKey", | ||
| "privateKey": "dummyPrivateKey", | ||
| "baseUrl": baseUrl, | ||
| "projectId": projectId, | ||
| "headers": customHeaders | ||
| }); | ||
|
|
||
| mockPool.intercept({ | ||
| "path": `/groups/${projectId}/databaseUsers/admin/myUsername?key1=value1`, | ||
| "method": "get", | ||
| "headers": { | ||
| "Accept": "application/vnd.atlas.2025-03-12+json", | ||
| "Custom-Header": "custom-value" | ||
| } | ||
| }) | ||
| .reply(200, {"user": "data"}); | ||
|
|
||
| const result = await client.user.get("myUsername", { | ||
| "key1": "value1", | ||
| "httpOptions": { | ||
| "headers": { | ||
| "Custom-Header": "custom-value" | ||
| } | ||
| } | ||
| }); | ||
| expect(result).to.equal({"user": "data"}); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe("HttpClient Direct Tests", () => { | ||
| const mockRequest = { | ||
| "request": stub().returns(new Promise(resolve => resolve({"data": "test data"}))) | ||
| }; | ||
|
|
||
| it("should handle headers merging properly", async () => { | ||
| const httpClient = new HttpClient(mockRequest, "publicKey", "privateKey", {"Default-Header": "default-value"}); | ||
|
|
||
| await httpClient.fetch("test-url", { | ||
| "headers": { | ||
| "Custom-Header": "custom-value" | ||
| } | ||
| }); | ||
|
|
||
| const expectedParams = { | ||
| "digestAuth": "publicKey:privateKey", | ||
| "dataType": "json", | ||
| "headers": { | ||
| "Default-Header": "default-value", | ||
| "Custom-Header": "custom-value" | ||
| } | ||
| }; | ||
|
|
||
| expect(mockRequest.request.calledWith("test-url", expectedParams)).to.be.true(); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot shouldn't there be a check that headers are being passed correctly?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're absolutely right! I've added tests to verify that headers are being passed correctly when using AtlasSearch methods:
The tests ensure that when a client is configured with custom headers (like
"Accept": "application/vnd.atlas.2025-03-12+json"), those headers are correctly propagated through AtlasSearch method calls.Commit: 1105829