Skip to content

fix(database): Adding toJSON() method to TransactionResult #104

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.

Sign up for GitHub

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 3 commits into from
Jul 25, 2017
Merged

fix(database): Adding toJSON() method to TransactionResult #104

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8482733
fix(database): Adding toJSON() method to TransactionResult
schmidt-sebastian Jul 25, 2017
4202199
fix(database): Making return type of toJSON explicit
schmidt-sebastian Jul 25, 2017
2c37843
Merge branch 'master' into mrschmidt-tojson
schmidt-sebastian Jul 25, 2017
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
2 changes: 1 addition & 1 deletion src/database/api/Reference.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ export class Reference extends Query {
*/
transaction(transactionUpdate: (a: any) => any,
onComplete?: (a: Error | null, b: boolean, c: DataSnapshot | null) => void,
applyLocally?: boolean): Promise<any> {
applyLocally?: boolean): Promise<TransactionResult> {
validateArgCount('Reference.transaction', 1, 3, arguments.length);
validateWritablePath('Reference.transaction', this.path);
validateCallback('Reference.transaction', 1, transactionUpdate, false);
Expand Down
9 changes: 9 additions & 0 deletions src/database/api/TransactionResult.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/

import { DataSnapshot } from './DataSnapshot';
import { validateArgCount } from '../../utils/validation';

export class TransactionResult {
/**
Expand All @@ -27,4 +28,12 @@ export class TransactionResult {
constructor(public committed: boolean, public snapshot: DataSnapshot) {

}

// Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary
// for end-users
toJSON(): any {
Copy link
Contributor

@mikelehen mikelehen Jul 25, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should really strive not to use "any". I think we can use "object" here.

Copy link
Contributor Author

@schmidt-sebastian schmidt-sebastian Jul 25, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

validateArgCount('TransactionResult.toJSON', 0, 1, arguments.length);
return { committed: this.committed, snapshot: this.snapshot.toJSON() };
}

}
10 changes: 10 additions & 0 deletions tests/database/transaction.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,16 @@ describe('Transaction Tests', function() {
expect(eventHelper.waiter()).to.equal(true);
});

it('Transaction result can be converted to JSON.', function() {
const node = (getRandomNode() as Reference);

return node.transaction(() => {
return 42;
}).then(transactionResult => {
expect(transactionResult.toJSON()).to.deep.equal({ committed: true, snapshot: 42 });
});
});

it('Non-aborted transaction sets committed to true in callback.', function(done) {
const node = (getRandomNode() as Reference);

Expand Down