chore: support for common interface to get a session to support multiplexed session #2204
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,161 @@ | ||||||
| /*! | ||||||
| * Copyright 2024 Google LLC. All Rights Reserved. | ||||||
| * | ||||||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||||||
| * you may not use this file except in compliance with the License. | ||||||
| * You may obtain a copy of the License at | ||||||
| * | ||||||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||||||
| * | ||||||
| * Unless required by applicable law or agreed to in writing, software | ||||||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||||||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||||
| * See the License for the specific language governing permissions and | ||||||
| * limitations under the License. | ||||||
| */ | ||||||
|
|
||||||
| import {Database, Session, Transaction} from '.'; | ||||||
| import { | ||||||
| MultiplexedSession, | ||||||
| MultiplexedSessionInterface, | ||||||
| } from './multiplexed-session'; | ||||||
| import { | ||||||
| SessionPool, | ||||||
| SessionPoolInterface, | ||||||
| SessionPoolOptions, | ||||||
| } from './session-pool'; | ||||||
| import {SessionPoolConstructor} from './database'; | ||||||
| import {ServiceObjectConfig} from '@google-cloud/common'; | ||||||
| const common = require('./common-grpc/service-object'); | ||||||
|
|
||||||
| /** | ||||||
| * @callback GetSessionCallback | ||||||
| * @param {?Error} error Request error, if any. | ||||||
| * @param {Session} session The read-write session. | ||||||
| * @param {Transaction} transaction The transaction object. | ||||||
| */ | ||||||
| export interface GetSessionCallback { | ||||||
| ( | ||||||
| err: Error | null, | ||||||
| session?: Session | null, | ||||||
| transaction?: Transaction | null | ||||||
| ): void; | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Interface for implementing session-factory logic. | ||||||
| * | ||||||
| * @interface SessionFactoryInterface | ||||||
| */ | ||||||
| export interface SessionFactoryInterface { | ||||||
| /** | ||||||
| * When called returns a session. | ||||||
| * | ||||||
| * @name SessionFactoryInterface#getSession | ||||||
| * @param {GetSessionCallback} callback The callback function. | ||||||
| */ | ||||||
| getSession(callback: GetSessionCallback): void; | ||||||
surbhigarg92 marked this conversation as resolved.
Show resolved
Hide resolved
surbhigarg92 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| /** | ||||||
| * When called returns the pool object. | ||||||
| * | ||||||
| * @name SessionFactoryInterface#getPool | ||||||
| */ | ||||||
| getPool(): SessionPoolInterface; | ||||||
|
|
||||||
| /** | ||||||
| * To be called when releasing a session. | ||||||
| * | ||||||
| * @name SessionFactoryInterface#release | ||||||
| * @param {Session} session The session to be released. | ||||||
| */ | ||||||
| release(session: Session): void; | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Creates a SessionFactory object to manage the creation of | ||||||
| * session-pool and multiplexed session. | ||||||
| * | ||||||
| * @class | ||||||
| * | ||||||
| * @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
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 |
||||||
| * configuration options or custom pool inteface. | ||||||
| */ | ||||||
| export class SessionFactory | ||||||
| extends common.GrpcServiceObject | ||||||
| implements SessionFactoryInterface | ||||||
| { | ||||||
| multiplexedSession_: MultiplexedSessionInterface; | ||||||
| pool_: SessionPoolInterface; | ||||||
| constructor( | ||||||
| database: Database, | ||||||
| name: String, | ||||||
| poolOptions?: SessionPoolConstructor | SessionPoolOptions | ||||||
| ) { | ||||||
| super({ | ||||||
| parent: database, | ||||||
| id: name, | ||||||
| } as {} as ServiceObjectConfig); | ||||||
| this.pool_ = | ||||||
| typeof poolOptions === 'function' | ||||||
| ? new (poolOptions as SessionPoolConstructor)(database, null) | ||||||
| : new SessionPool(database, poolOptions); | ||||||
| this.pool_.on('error', this.emit.bind(database, 'error')); | ||||||
| this.pool_.open(); | ||||||
| this.multiplexedSession_ = new MultiplexedSession(database); | ||||||
| // Multiplexed sessions should only be created if its enabled. | ||||||
| if ((this.multiplexedSession_ as MultiplexedSession).isMultiplexedEnabled) { | ||||||
| this.multiplexedSession_.on('error', this.emit.bind(database, 'error')); | ||||||
| this.multiplexedSession_.createSession(); | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * 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. | ||||||
| */ | ||||||
|
|
||||||
| getSession(callback: GetSessionCallback): void { | ||||||
| const sessionHandler = (this.multiplexedSession_ as MultiplexedSession) | ||||||
| .isMultiplexedEnabled | ||||||
| ? this.multiplexedSession_ | ||||||
| : this.pool_; | ||||||
|
|
||||||
| sessionHandler!.getSession((err, session) => callback(err, session)); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Returns the regular session pool object. | ||||||
| * | ||||||
| * @returns {SessionPoolInterface} The session pool used by current instance. | ||||||
| */ | ||||||
|
|
||||||
| getPool(): SessionPoolInterface { | ||||||
| return this.pool_; | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * 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. | ||||||
| */ | ||||||
| release(session: Session): void { | ||||||
| if ( | ||||||
| !(this.multiplexedSession_ as MultiplexedSession).isMultiplexedEnabled | ||||||
| ) { | ||||||
| this.pool_.release(session); | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.