Expose processed transactions through the REST API (#981) (#982)

* Add getAllTransactions() and getTransactionByID() to LoopBack connector * Expose getAllTransactions() and getTransactionByID() via REST server * Remove temporary debugging console.log()

Author: Simon Stone

packages/composer-rest-server/server/boot/composer-discovery.js

@@ -125,7 +125,9 @@ function registerSystemMethods(app, dataSource) {
  const registerMethods = [
  registerPingMethod,
  registerIssueIdentityMethod,
- registerRevokeIdentityMethod
+ registerRevokeIdentityMethod,
+ registerGetAllTransactionsMethod,
+ registerGetTransactionByIDMethod
  ];
  registerMethods.forEach((registerMethod) => {
  registerMethod(app, dataSource, System, connector);
@@ -331,6 +333,81 @@ function registerRevokeIdentityMethod(app, dataSource, System, connector) {
 
 }
 
+/**
+ * Register the 'getAllTransactions' Composer system method.
+ * @param {Object} app The LoopBack application.
+ * @param {Object} dataSource The LoopBack data source.
+ * @param {Object} System The System model class.
+ * @param {Object} connector The LoopBack connector.
+ */
+function registerGetAllTransactionsMethod(app, dataSource, System, connector) {
+
+ // Define and register the method.
+ System.getAllTransactions = (options, callback) => {
+ connector.getAllTransactions(options, callback);
+ };
+ System.remoteMethod(
+ 'getAllTransactions', {
+ description: 'Get all transactions from the transaction registry',
+ accepts: [{
+ arg: 'options',
+ type: 'object',
+ http: 'optionsFromRequest'
+ }],
+ returns: {
+ type: [ 'object' ],
+ root: true
+ },
+ http: {
+ verb: 'get',
+ path: '/transactions'
+ }
+ }
+ );
+
+}
+
+/**
+ * Register the 'getTransactionByID' Composer system method.
+ * @param {Object} app The LoopBack application.
+ * @param {Object} dataSource The LoopBack data source.
+ * @param {Object} System The System model class.
+ * @param {Object} connector The LoopBack connector.
+ */
+function registerGetTransactionByIDMethod(app, dataSource, System, connector) {
+
+ // Define and register the method.
+ System.getTransactionByID = (id, options, callback) => {
+ connector.getTransactionByID(id, options, callback);
+ };
+ System.remoteMethod(
+ 'getTransactionByID', {
+ description: 'Get the specified transaction from the transaction registry',
+ accepts: [{
+ arg: 'id',
+ type: 'string',
+ required: true,
+ http: {
+ source: 'path'
+ }
+ }, {
+ arg: 'options',
+ type: 'object',
+ http: 'optionsFromRequest'
+ }],
+ returns: {
+ type: 'object',
+ root: true
+ },
+ http: {
+ verb: 'get',
+ path: '/transactions/:id'
+ }
+ }
+ );
+
+}
+
 /**
  * Discover all of the model definitions in the specified LoopBack data source.
  * @param {Object} dataSource The LoopBack data source.
@@ -503,7 +580,7 @@ module.exports = function (app, callback) {
 
  // Apply any required updates to the specified model schema.
  modelSchema = updateModelSchema(modelSchema);
- console.log(modelSchema);
+
  // This call creates the model class from the model schema.
  let model = app.loopback.createModel(modelSchema);
 

packages/composer-rest-server/test/system.js

@@ -40,8 +40,56 @@ describe('System REST API unit tests', () => {
  $class: 'org.acme.bond.Member',
  memberId: 'MEMBER_2',
  name: 'Bob'
+ }, {
+ $class: 'org.acme.bond.Issuer',
+ memberId: 'ISSUER_1',
+ name: 'Charlie'
+ }, {
+ $class: 'org.acme.bond.Issuer',
+ memberId: 'ISSUER_2',
+ name: 'Dave'
+ }];
+
+ const transactionData = [{
+ $class: 'org.acme.bond.PublishBond',
+ ISINCode: 'ISIN_1',
+ bond: {
+ $class: 'org.acme.bond.Bond',
+ instrumentId: [ 'INST_1' ],
+ exchangeId: [ 'EXCHG_1' ],
+ maturity: '1970-01-01T00:00:00.000Z',
+ parValue: 1.0,
+ faceAmount: 1.0,
+ paymentFrequency: {
+ $class: 'org.acme.bond.PaymentFrequency',
+ periodMultiplier: 1,
+ period: 'DAY'
+ },
+ dayCountFraction: 'wat',
+ issuer: 'resource:org.acme.bond.Issuer#ISSUER_1'
+ }
+ }, {
+ $class: 'org.acme.bond.PublishBond',
+ ISINCode: 'ISIN_2',
+ bond: {
+ $class: 'org.acme.bond.Bond',
+ instrumentId: [ 'INST_2' ],
+ exchangeId: [ 'EXCHG_2' ],
+ maturity: '1970-01-01T00:00:00.000Z',
+ parValue: 2.0,
+ faceAmount: 2.0,
+ paymentFrequency: {
+ $class: 'org.acme.bond.PaymentFrequency',
+ periodMultiplier: 2,
+ period: 'DAY'
+ },
+ dayCountFraction: 'wat',
+ issuer: 'resource:org.acme.bond.Issuer#ISSUER_2'
+ }
  }];
 
+ const transactionIds = [];
+
  let app;
  let businessNetworkConnection;
  let participantRegistry;
@@ -89,8 +137,29 @@ describe('System REST API unit tests', () => {
  serializer.fromJSON(participantData[1])
  ]);
  })
+ .then(() => {
+ return businessNetworkConnection.getParticipantRegistry('org.acme.bond.Issuer');
+ })
+ .then((participantRegistry_) => {
+ participantRegistry = participantRegistry_;
+ return participantRegistry.addAll([
+ serializer.fromJSON(participantData[2]),
+ serializer.fromJSON(participantData[3])
+ ]);
+ })
  .then(() => {
  return businessNetworkConnection.issueIdentity('org.acme.bond.Member#MEMBER_2', 'bob1', { issuer: true });
+ })
+ .then(() => {
+ return transactionData.reduce((promise, transaction) => {
+ return promise.then(() => {
+ const tx = serializer.fromJSON(transaction);
+ return businessNetworkConnection.submitTransaction(tx)
+ .then(() => {
+ transactionIds.push(tx.getIdentifier());
+ });
+ });
+ }, Promise.resolve());
  });
  });
 
@@ -174,4 +243,47 @@ describe('System REST API unit tests', () => {
 
  });
 
+ describe('GET /transactions', () => {
+
+ it('should return all of the transactions', () => {
+ return chai.request(app)
+ .get('/api/system/transactions')
+ .then((res) => {
+ res.should.be.json;
+ res.body.sort((a, b) => {
+ return a.ISINCode.localeCompare(b.ISINCode);
+ }).map((tx) => {
+ delete tx.transactionId;
+ delete tx.timestamp;
+ return tx;
+ }).should.deep.equal(transactionData);
+ });
+ });
+
+ });
+
+ describe('GET /transactions/:id', () => {
+
+ it('should return the specified transaction', () => {
+ return chai.request(app)
+ .get('/api/system/transactions/' + transactionIds[0])
+ .then((res) => {
+ res.should.be.json;
+ const tx = res.body;
+ delete tx.transactionId;
+ delete tx.timestamp;
+ tx.should.deep.equal(transactionData[0]);
+ });
+ });
+
+ it('should return a 404 if the specified transaction does not exist', () => {
+ return chai.request(app)
+ .get('/api/system/transactions/LOL')
+ .catch((err) => {
+ err.response.should.have.status(404);
+ });
+ });
+
+ });
+
 });

packages/loopback-connector-composer/lib/businessnetworkconnector.js

@@ -792,6 +792,63 @@ class BusinessNetworkConnector extends Connector {
  });
  }
 
+ /**
+ * Get all of the transactions from the transaction registry.
+ * @param {Object} options The LoopBack options.
+ * @param {function} callback The callback to call when complete.
+ * @returns {Promise} A promise that is resolved when complete.
+ */
+ getAllTransactions(options, callback) {
+ debug('getAllTransactions', options);
+ return this.ensureConnected(options)
+ .then((businessNetworkConnection) => {
+ return businessNetworkConnection.getTransactionRegistry();
+ })
+ .then((transactionRegistry) => {
+ return transactionRegistry.getAll();
+ })
+ .then((transactions) => {
+ const result = transactions.map((transaction) => {
+ return this.serializer.toJSON(transaction);
+ });
+ callback(null, result);
+ })
+ .catch((error) => {
+ debug('getAllTransactions', 'error thrown doing getAllTransactions', error);
+ callback(error);
+ });
+ }
+
+ /**
+ * Get the transaction with the specified ID from the transaction registry.
+ * @param {string} id The ID for the transaction.
+ * @param {Object} options The LoopBack options.
+ * @param {function} callback The callback to call when complete.
+ * @returns {Promise} A promise that is resolved when complete.
+ */
+ getTransactionByID(id, options, callback) {
+ debug('getTransactionByID', options);
+ return this.ensureConnected(options)
+ .then((businessNetworkConnection) => {
+ return businessNetworkConnection.getTransactionRegistry();
+ })
+ .then((transactionRegistry) => {
+ return transactionRegistry.get(id);
+ })
+ .then((transaction) => {
+ const result = this.serializer.toJSON(transaction);
+ callback(null, result);
+ })
+ .catch((error) => {
+ debug('getTransactionByID', 'error thrown doing getTransactionByID', error);
+ if (error.message.match(/does not exist/)) {
+ error.statusCode = error.status = 404;
+ }
+ callback(error);
+ });
+
+ }
+
  /**
  * Retrieve the list of all available model names, or the model names in a
  * specified namespace.