Skip to content
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

Improve Unit Tests for Result and Record #727

Merged
merged 1 commit into from
Apr 27, 2021
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
105 changes: 52 additions & 53 deletions core/src/result.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ import ResultSummary from './result-summary'
import Record from './record'
import { Query } from './types'
import { observer, util, connectionHolder } from './internal'
import { CompletedObserver, FailedObserver } from './internal/observers'

const { EMPTY_CONNECTION_HOLDER } = connectionHolder

Expand Down Expand Up @@ -130,12 +129,14 @@ class Result implements Promise<QueryResult> {
*/
keys(): Promise<string[]> {
return new Promise((resolve, reject) => {
this._streamObserverPromise.then(observer =>
observer.subscribe({
onKeys: keys => resolve(keys),
onError: err => reject(err)
})
)
this._streamObserverPromise
.then(observer =>
observer.subscribe({
onKeys: keys => resolve(keys),
onError: err => reject(err)
})
)
.catch(reject)
})
}

Expand All @@ -150,13 +151,16 @@ class Result implements Promise<QueryResult> {
*/
summary(): Promise<ResultSummary> {
return new Promise((resolve, reject) => {
this._streamObserverPromise.then(o => {
o.cancel()
o.subscribe({
onCompleted: metadata => resolve(metadata),
onError: err => reject(err)
this._streamObserverPromise
.then(o => {
o.cancel()
o.subscribe({
onCompleted: metadata =>
this._createSummary(metadata).then(resolve, reject),
onError: err => reject(err)
})
})
})
.catch(reject)
})
}

Expand Down Expand Up @@ -247,43 +251,8 @@ class Result implements Promise<QueryResult> {
subscribe(observer: ResultObserver): void {
const onCompletedOriginal = observer.onCompleted || DEFAULT_ON_COMPLETED
const onCompletedWrapper = (metadata: any) => {
const connectionHolder = this._connectionHolder
const {
validatedQuery: query,
params: parameters
} = util.validateQueryAndParameters(this._query, this._parameters, {
skipAsserts: true
})

function complete(protocolVersion?: number) {
onCompletedOriginal.call(
observer,
new ResultSummary(query, parameters, metadata, protocolVersion)
)
}

function release() {
// notify connection holder that the used connection is not needed any more because result has
// been fully consumed; call the original onCompleted callback after that
return connectionHolder.releaseConnection()
}

connectionHolder.getConnection().then(
// onFulfilled:
connection => {
release().then(() =>
complete(
connection !== undefined
? connection.protocol().version
: undefined
)
)
},

// onRejected:
_ => {
complete()
}
this._createSummary(metadata).then(summary =>
onCompletedOriginal.call(observer, summary)
)
}

Expand All @@ -300,9 +269,11 @@ class Result implements Promise<QueryResult> {
}
observer.onError = onErrorWrapper

this._streamObserverPromise.then(o => {
return o.subscribe(observer)
})
this._streamObserverPromise
.then(o => {
return o.subscribe(observer)
})
.catch(error => observer.onError!(error))
}

/**
Expand All @@ -315,6 +286,34 @@ class Result implements Promise<QueryResult> {
_cancel(): void {
this._streamObserverPromise.then(o => o.cancel())
}

private _createSummary(metadata: any): Promise<ResultSummary> {
const {
validatedQuery: query,
params: parameters
} = util.validateQueryAndParameters(this._query, this._parameters, {
skipAsserts: true
})
const connectionHolder = this._connectionHolder

return connectionHolder
.getConnection()
.then(
// onFulfilled:
connection =>
connectionHolder
.releaseConnection()
.then(() =>
connection ? connection.protocol().version : undefined
),
// onRejected:
_ => undefined
)
.then(
protocolVersion =>
new ResultSummary(query, parameters, metadata, protocolVersion)
)
}
}

function captureStacktrace(): string | null {
Expand Down
11 changes: 6 additions & 5 deletions test/record.test.js → core/test/record.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@
* limitations under the License.
*/

import { Neo4jError, Record } from 'neo4j-driver-core'
import { newError } from '../src'
import Record from '../src/record'

describe('#unit Record', () => {
describe('Record', () => {
it('should allow getting fields by name', () => {
// Given
const record = new Record(['name'], ['Bob'])
Expand Down Expand Up @@ -63,7 +64,7 @@ describe('#unit Record', () => {
expect(() => {
record.get('age')
}).toThrow(
new Neo4jError(
newError(
"This record has no field with key 'age', available key are: [name]."
)
)
Expand All @@ -85,7 +86,7 @@ describe('#unit Record', () => {
expect(() => {
record.get(1)
}).toThrow(
new Neo4jError(
newError(
"This record has no field with index '1'. Remember that indexes start at `0`, " +
'and make sure your query returns records in the shape you meant it to.'
)
Expand All @@ -102,7 +103,7 @@ describe('#unit Record', () => {
it('should allow forEach through the record', () => {
// Given
const record = new Record(['name', 'age'], ['Bob', 45])
const result = []
const result: [any, string, Record][] = []

// When
record.forEach((value, key, record) => {
Expand Down
Loading