This repository was archived by the owner on Mar 4, 2026. It is now read-only.
chore: support for common interface to get a session to support multiplexed session#2204
Merged
gcf-merge-on-green[bot] merged 12 commits intomainfrom Dec 27, 2024
Merged
chore: support for common interface to get a session to support multiplexed session#2204gcf-merge-on-green[bot] merged 12 commits intomainfrom
gcf-merge-on-green[bot] merged 12 commits intomainfrom
Conversation
bddd1d4 to
421a5a1
Compare
6061d99 to
df92e41
Compare
21394ef to
3730a8a
Compare
e49f2a4 to
3f2117a
Compare
e24245d to
be238ed
Compare
a5fa3d0 to
4024beb
Compare
Comment on lines
+96
to
+122
| /** | ||
| * Retrieves the session, either the regular session or the multiplexed session based upon the environment varibale | ||
| * If the environment variable GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS is set to `true` the method will attempt to | ||
| * retrieve the multiplexed session. Otherwise it will retrieve the session from the pool. | ||
| * | ||
| * The session is returned asynchronously via the provided callback, which will receive either an error or the session object. | ||
| * @param callback | ||
| */ |
Contributor
There was a problem hiding this comment.
Suggested change
| /** | |
| * Retrieves the session, either the regular session or the multiplexed session based upon the environment varibale | |
| * If the environment variable GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS is set to `true` the method will attempt to | |
| * retrieve the multiplexed session. Otherwise it will retrieve the session from the pool. | |
| * | |
| * The session is returned asynchronously via the provided callback, which will receive either an error or the session object. | |
| * @param callback | |
| */ | |
| /** | |
| * Retrieves a session, either a regular session or a multiplexed session, based on the environment variable configuration. | |
| * | |
| * If the environment variable `GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS` is set to `true`, the method will attempt to | |
| * retrieve a multiplexed session. Otherwise, it will retrieve a session from the regular pool. | |
| * | |
| * @param {GetSessionCallback} callback The callback function. | |
| */ |
Comment on lines
+114
to
+138
| /** | ||
| * Returns the SessionPoolInterface used by the current instance, which provide access to the session pool | ||
| * for obtaining database sessions. | ||
| * | ||
| * @returns {SessionPoolInterface} The session pool used by current instance. | ||
| * This object allows interaction with the pool for acquiring and managing sessions. | ||
| */ | ||
|
|
Contributor
There was a problem hiding this comment.
Suggested change
| /** | |
| * Returns the SessionPoolInterface used by the current instance, which provide access to the session pool | |
| * for obtaining database sessions. | |
| * | |
| * @returns {SessionPoolInterface} The session pool used by current instance. | |
| * This object allows interaction with the pool for acquiring and managing sessions. | |
| */ | |
| /** | |
| * Returns the regular session pool object. | |
| * | |
| * @returns {SessionPoolInterface} The session pool used by current instance. | |
| */ | |
src/session-factory.ts
Outdated
| * @throws {Error} Throws an error if the session is invalid or cannot be released. | ||
| */ | ||
| release(session: Session): void { | ||
| if (!this.isMuxCreated) { |
Contributor
There was a problem hiding this comment.
isMultiplexedEnabled
Suggested change
| if (!this.isMuxCreated) { | |
| if (!this.isMultiplexedEnabled) { |
Comment on lines
+126
to
+153
| /** | ||
| * Releases the session back to the pool. | ||
| * | ||
| * This method is used to return the session back to the pool after it is no longer needed. | ||
| * | ||
| * It only performs the operation if the Multiplexed Session is disabled which is controlled via the | ||
| * env variable GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS. | ||
| * | ||
| * @param session The session to be released. This should be an instance of `Session` that was previously | ||
| * acquired from the session pool. | ||
| * | ||
| * @throws {Error} Throws an error if the session is invalid or cannot be released. | ||
| */ |
Contributor
There was a problem hiding this comment.
Suggested change
| /** | |
| * Releases the session back to the pool. | |
| * | |
| * This method is used to return the session back to the pool after it is no longer needed. | |
| * | |
| * It only performs the operation if the Multiplexed Session is disabled which is controlled via the | |
| * env variable GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS. | |
| * | |
| * @param session The session to be released. This should be an instance of `Session` that was previously | |
| * acquired from the session pool. | |
| * | |
| * @throws {Error} Throws an error if the session is invalid or cannot be released. | |
| */ | |
| /** | |
| * Releases a session back to the session pool. | |
| * | |
| * This method returns a session to the pool after it is no longer needed. | |
| * It is a no-op for multiplexed sessions. | |
| * | |
| * @param {Session} session - The session to be released. This should be an instance of `Session` that was | |
| * previously acquired from the session pool. | |
| * | |
| * @throws {Error} If the session is invalid or cannot be released. | |
| */ |
test/session-factory.ts
Outdated
| import {ReleaseError} from '../src/session-pool'; | ||
|
|
||
| describe('SessionFactory', () => { | ||
| process.env.GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS = 'true'; |
Contributor
There was a problem hiding this comment.
Can we initialize this in before block and clear in after block
Contributor
Author
There was a problem hiding this comment.
we need to keep this in after block so that others test which will be running after this test don't fail on because of the change in env configuration
test/session-factory.ts
Outdated
| assert.strictEqual(openStub.callCount, 1); | ||
| }); | ||
|
|
||
| describe('when env GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS is enabled', () => { |
Contributor
There was a problem hiding this comment.
Suggested change
| describe('when env GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS is enabled', () => { | |
| describe('when GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS is enabled', () => { |
test/session-factory.ts
Outdated
| }); | ||
|
|
||
| describe('getSession', () => { | ||
| describe('for regular session', () => { |
Contributor
There was a problem hiding this comment.
Suggested change
| describe('for regular session', () => { | |
| describe('when GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS is disabled', () => { |
test/session-factory.ts
Outdated
| process.env.GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS = 'false'; | ||
| }); | ||
|
|
||
| it('should return the regular session if GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS env is disabled', done => { |
Contributor
There was a problem hiding this comment.
Suggested change
| it('should return the regular session if GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS env is disabled', done => { | |
| it('should retrieve a regular session from the pool', done => { |
test/session-factory.ts
Outdated
| }); | ||
| }); | ||
|
|
||
| it('should return the error from getSession if GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS env is disabled and regular session creation get failed', done => { |
Contributor
There was a problem hiding this comment.
Suggested change
| it('should return the error from getSession if GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS env is disabled and regular session creation get failed', done => { | |
| it('should propagate errors when regular session retrieval fails', done => { |
Contributor
There was a problem hiding this comment.
I have given a few examples on how the test cases should be named. Please updated others as well
Contributor
Author
There was a problem hiding this comment.
modified other tests as well
ae9c1fe to
56c53c0
Compare
56c53c0 to
5509f01
Compare
* e2eTracing * context propagation * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Add end to end tracing header and refactore resource header * Add end to end tracing header and refactore resource header --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
…taleness (#2207) * chore: integration test fix * chore: Improve error message for Read-only transaction with bounded staleness * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * review comments * review comments * review comment --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
deef307 to
346008a
Compare
| * | ||
| * @param {Database} database Database object. | ||
| * @param {String} name Name of the database. | ||
| * @param {SessionPoolOptions|SessionPoolInterface} options Session pool |
Contributor
There was a problem hiding this comment.
SessionPoolConstructor right
Suggested change
| * @param {SessionPoolOptions|SessionPoolInterface} options Session pool | |
| * @param {SessionPoolOptions| SessionPoolConstructor} options Session pool |
Contributor
There was a problem hiding this comment.
Please let me know if my understanding is incorrect ?
Contributor
Author
There was a problem hiding this comment.
Since, the SessionPoolConstructor is eventually creating SessionPoolInterface object, hence we can keep SessionPoolInterface here in the documentation
surbhigarg92
approved these changes
Dec 27, 2024
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
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.
This PR contains the common interface class SessionFactory which will be responsible for the creation of the Session Pool and the Multiplexed Session(if the env variable would be set to true) upon client initialization.
This PR also contains the getSession method which will return the session(multiplexed/regular) based upon the env variable value.