Skip to content

Fix lack of ProtocolVersion in the Result.summary() #937

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 5 additions & 2 deletions packages/core/src/result.ts
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,10 @@ class Result implements Promise<QueryResult> {
const onKeysOriginal = observer.onKeys ?? DEFAULT_ON_KEYS

const onCompletedWrapper = (metadata: any): void => {
this._createSummary(metadata).then(summary => {
this._releaseConnectionAndGetSummary(metadata).then(summary => {
if (this._summary !== null) {
return onCompletedOriginal.call(observer, this._summary)
}
this._summary = summary
return onCompletedOriginal.call(observer, summary)
}).catch(onErrorOriginal)
Expand Down Expand Up @@ -484,7 +487,7 @@ class Result implements Promise<QueryResult> {
* @param metadata
* @returns
*/
private _createSummary (metadata: any): Promise<ResultSummary> {
private _releaseConnectionAndGetSummary (metadata: any): Promise<ResultSummary> {
const {
validatedQuery: query,
params: parameters
Expand Down
44 changes: 43 additions & 1 deletion packages/core/test/result.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import {
} from '../src'

import Result from '../src/result'
import FakeConnection from './utils/connection.fake'

describe('Result', () => {
const expectedError = newError('some error')
Expand Down Expand Up @@ -146,11 +147,14 @@ describe('Result', () => {
{ query: 'query', parameters: { b: 2 } }
]
])('when query=%s and parameters=%s', (query, params, expected) => {
let connectionHolderMock: connectionHolder.ConnectionHolder
beforeEach(() => {
connectionHolderMock = new connectionHolder.ConnectionHolder({})
result = new Result(
Promise.resolve(streamObserverMock),
query,
params
params,
connectionHolderMock
)
})

Expand All @@ -174,6 +178,44 @@ describe('Result', () => {
expect(summary).toEqual(expectedSummary)
})

it('should resolve pre-existing summary', async () => {
const metadata = {
resultConsumedAfter: 20,
resultAvailableAfter: 124,
extraInfo: 'extra'
}
const protocolVersion = 5.0

const expectedSummary = new ResultSummary(
expected.query,
expected.parameters,
metadata,
protocolVersion
)

jest.spyOn(connectionHolderMock, 'getConnection')
.mockImplementationOnce(async () => {
const conn = new FakeConnection()
conn.protocolVersion = protocolVersion
return conn
})

jest.spyOn(connectionHolderMock, 'releaseConnection')
.mockImplementationOnce(async () => null)

const iterator = result[Symbol.asyncIterator]()
const next = iterator.next()
const summaryPromise = result.summary()

streamObserverMock.onCompleted(metadata)

const { value } = await next
const summary = await summaryPromise

expect(value).toEqual(expectedSummary)
expect(summary).toEqual(expectedSummary)
})

it('should reject a pre-existing error', async () => {
const expectedError = newError('the expected error')
streamObserverMock.onError(expectedError)
Expand Down