Skip to content

Commit

Permalink
Add a 'Type cache' to the Builder class
Browse files Browse the repository at this point in the history 
- Builder can store each created Type in a cache

- Builder can retrieve a Type from the cache using
the typeId

- AbstractObject can read/write the ID as Hex
value

- the Type Functions are able to retrieve the
returned Type from the first 4 bytes of
the buffer

- update Vector class as well

- update all the related unit-test
  • Loading branch information
@enricostara
enricostara committed Sep 29, 2014
1 parent 556dd84 commit bd676cb
Show file tree
Hide file tree
Showing 8 changed files with 63 additions and 39 deletions.
2 changes: 1 addition & 1 deletion lib/telegram.link.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ TelegramLink.prototype.authorization = function (callback, errorback) {
var pqAsBuffer = pqFinder.getPQAsBuffer();
var newNonce32 = crypto.createNonce(32);
var serverNonce = resPQ.server_nonce;
var pqInnerData = new mtproto.P_Q_inner_data({props: {
var pqInnerData = new mtproto.P_q_inner_data({props: {
pq: resPQ.pq,
p: pqAsBuffer[0],
q: pqAsBuffer[1],
Expand Down
15 changes: 7 additions & 8 deletions lib/type_language/abstract_object.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
// the TypeLanguage binary format

// Import dependencies
var logger = require('../util/logger')('type_language.AbstractObject');
var BigInt = require('bignum');

// The constructor may be called giving a `Buffer` with the binary image - eventually starting from an `offset` -
Expand All @@ -31,15 +30,15 @@ function AbstractObject(buffer, offset) {
// The base method to de-serialize the object
AbstractObject.prototype.deserialize = function () {
if (!this.isReadonly()) {
logger.debug('Unable to de-serialize, the buffer is undefined');
if (this.constructor.logger) this.constructor.logger.warn('Unable to de-serialize, the buffer is undefined');
return false;
}
var id = this.readInt();
var id = this._readBytes(4).toString('hex');
if (this.constructor.logger && this.constructor.logger.isDebugEnabled()) {
this.constructor.logger.debug('read ID = %s', id);
}
if (this.id != id) {
logger.warn('Unable to de-serialize, (read id) %s != (this.id) %s', id, this.id);
if (this.constructor.logger) this.constructor.logger.warn('Unable to de-serialize, (read id) %s != (this.id) %s', id, this.id);
return false;
}
return this;
Expand All @@ -50,7 +49,7 @@ AbstractObject.prototype.serialize = function () {
if (this.constructor.logger && this.constructor.logger.isDebugEnabled()) {
this.constructor.logger.debug('write ID = %s', this.id);
}
return this.writeInt(this.id);
return this._writeBytes(new Buffer(this.id, 'hex'));
};

// The method finalizes the serialization process and retrieves the `Buffer` image of the object,
Expand Down Expand Up @@ -166,12 +165,12 @@ AbstractObject.prototype.writeInt256 = function (bigInteger) {
};


// The method reads an `int` value starting from the current position, you may request the value `signed` or not
AbstractObject.prototype.readInt = function (signed) {
// The method reads an `int` value starting from the current position
AbstractObject.prototype.readInt = function () {
if (!this.isReadonly() || (this._readOffset + 4) > this._buffer.length) {
return undefined;
}
var intValue = signed ? this._buffer.readInt32LE(this._readOffset) : this._buffer.readUInt32LE(this._readOffset);
var intValue = this._buffer.readUInt32LE(this._readOffset);
// Reading position will be increased of 4
this._readOffset += 4;
return intValue;
Expand Down
52 changes: 40 additions & 12 deletions lib/type_language/builder.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,22 @@ module.exports = exports = Builder;

// Export the method
exports.buildTypes = buildTypes;
exports.registerType = registerType;
exports.retrieveType = retrieveType;

// Import dependencies
var util = require('util');
var createLogger = require('../util/logger');
var logger = createLogger('type_language.Builder');
var AbstractObject = require('./index').AbstractObject;

// type register

var types = {};

// Compile a reg exp to resolve Type declaration in TL-Schema
var typeResolver = /^(\w+)(<(\w+)>)?$/;


function Builder(options) {
this.module = options.module;
if (!this.module) {
Expand Down Expand Up @@ -88,6 +92,7 @@ Builder.prototype.buildTypeFunction = function () {
'\tvar callback = options.callback;\n' +
'\tvar errorback = options.errorback;\n' +
'\tvar mtproto = arguments.callee.require(\'mtproto\');\n' +
'\tvar type_language = arguments.callee.require(\'type_language\');\n' +
'\tvar module = arguments.callee.require(\'' + this.module + '\');\n';
body +=
'\tvar reqPayload = new module._' + methodName + '(options);\n' +
Expand All @@ -98,7 +103,8 @@ Builder.prototype.buildTypeFunction = function () {
'\t\t\tconn.read(function (response) {\n' +
'\t\t\t\tvar resMsg = new mtproto.PlainMessage({buffer: response}).deserialize();\n' +
'\t\t\t\tresMsg = resMsg.getMessage();\n' +
'\t\t\t\tvar resObj = new module.' + this.tlSchema.type + '({buffer: resMsg});\n' +
'\t\t\t\tvar Type = type_language.Builder.retrieveType(resMsg);\n' +
'\t\t\t\tvar resObj = new Type({buffer: resMsg});\n' +
'\t\t\t\tcallback(resObj.deserialize());\n' +
'\t\t\t}, errorback);\n' +
'\t\t}, errorback);\n' +
Expand All @@ -118,20 +124,24 @@ Builder.prototype.buildTypeFunction = function () {
// This function builds a new `TypeLanguage` class (an `AbstractObject` concrete sub-class)
// parsing the `TL-Schema constructor`
Builder.prototype.buildTypeConstructor = function () {

var typeNameProperty = (this.tlSchema.method ? 'method' : 'type');

// Start creating the body of the new Type constructor, first calling super()
var body =
'\tvar super_ = this.constructor.super_.bind(this);\n' +
'\tvar opts = options ? options : {};\n' +
'\tthis.constructor.util._extend(this, opts.props);\n' +
'\tsuper_(opts.buffer, opts.offset);\n';
// Init fields
var typeName = this.tlSchema[typeNameProperty];
var typeName = this.tlSchema.method ?
this.tlSchema.method :
(this.tlSchema.predicate.charAt(0).toUpperCase() + this.tlSchema.predicate.slice(1));

var buffer = new Buffer(4);
buffer.writeUInt32LE(this.tlSchema.id, 0, true);
var typeId = buffer.toString('hex');
var fullTypeName = this.module + '.' + typeName;
body +=
'\tthis.id = "' + this.tlSchema.id + '";\n' +
'\tthis.typeName = "' + typeName + '";\n';
'\tthis.id = "' + typeId + '";\n' +
'\tthis.typeName = "' + fullTypeName + '";\n';
body += this._buildSerialize();
body += this._buildDeserialize();
// Add to body all the read/write methods
Expand All @@ -145,11 +155,13 @@ Builder.prototype.buildTypeConstructor = function () {
/*jshint evil:true */
// Create the new Type sub-class of AbstractObject
var typeConstructor = new Function('options', body);
typeConstructor.id = typeId;
typeConstructor.typeName = fullTypeName;
typeConstructor.require = this.require;
typeConstructor.util = require('util');
typeConstructor.logger = createLogger(this.module + '.' + typeName);
typeConstructor.logger = createLogger(fullTypeName);
util.inherits(typeConstructor, AbstractObject);
return typeConstructor;
return registerType(typeConstructor);
};

// Create the `serialize()` method
Expand Down Expand Up @@ -255,7 +267,7 @@ Builder.prototype._buildDeserialize = function () {

// Create the `read[property]()` method
Builder.prototype._buildReadProperty = function (propertyName, typeName) {
var functionName = 'read' + propertyName.charAt(0).toUpperCase() + propertyName.slice(1);
var functionName = 'read' + (propertyName.charAt(0).toUpperCase() + propertyName.slice(1));
var body =
'\tthis.' + functionName + ' = function ' + functionName + '() {\n';
body +=
Expand All @@ -269,12 +281,28 @@ Builder.prototype._buildReadProperty = function (propertyName, typeName) {
return functionName;
};


// Register a Type constructor
function registerType(type) {
if(logger.isDebugEnabled()) logger.debug('Register Type \'%s\' with id [%s]', type.typeName, type.id);
return (types[type.id] = type);
}

// Retrieve a Type constructor
function retrieveType(buffer) {
var typeId = buffer.slice(0,4).toString('hex');
var type = types[typeId];
if(logger.isDebugEnabled()) logger.debug('Retrive Type \'%s\' with id [%s]', type.typeName, typeId);
return type;
}


// Types builder
function buildTypes(schemas, types, targetModule, isMethodType) {
for (var i = 0; i < schemas.length; i++) {
var type = schemas[i];
if (types.lastIndexOf(type[isMethodType ? 'method' : 'type']) >= 0) {
var typeName = isMethodType ? type.method : type.type;
var typeName = isMethodType ? type.method : (type.predicate.charAt(0).toUpperCase() + type.predicate.slice(1));
var builder = new Builder({module: 'mtproto', tlSchema: type, buildFunction: isMethodType});
targetModule[typeName] = builder.getType();
targetModule['_' + typeName] = builder.getFunctionPayload();
Expand Down
3 changes: 2 additions & 1 deletion lib/type_language/vector.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ function Vector(options) {
var super_ = this.constructor.super_.bind(this);
var opts = util._extend({ type: 'int'}, options);
super_(opts.buffer, opts.offset);
this.id = 481674261;
this.id = '15c4b51c';
this.type = opts.type.charAt(0).toUpperCase() + opts.type.slice(1);
this._list = !opts.list ? [] : opts.list;
this.constructor.logger = require('../util/logger')('type_language.Vector');
}

// The method de-serializes the list starting from the initialized buffer
Expand Down
2 changes: 2 additions & 0 deletions test/mtproto.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ describe('mtproto', function () {
})
});

/*
describe('#class building', function () {
it('should build all requested classes', function (done) {
for (var i = 0; i < mtproto._classes.length; i++) {
Expand All @@ -84,6 +85,7 @@ describe('mtproto', function () {
done();
})
});
*/

describe('PlainMessage', function () {

Expand Down
6 changes: 0 additions & 6 deletions test/type_language/abstract_object.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,14 +116,8 @@ describe('AbstractObject', function () {
})
});


describe('#readInt()', function () {
it('should read an int value', function (done) {
var obj = new AbstractObject(new Buffer('feffffff', 'hex'));
var intValue = obj.readInt(true);
intValue.should.be.equal(-2);
obj.getReadOffset().should.be.equal(4);

obj = new AbstractObject(new Buffer('feffffff', 'hex'));
intValue = obj.readInt();
intValue.should.be.equal(4294967294);
Expand Down
16 changes: 8 additions & 8 deletions test/type_language/builder.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ describe('Builder', function () {

describe('#buildTypeConstructor({P_Q_inner_data})', function () {
it('should return a P_Q_inner_data', function (done) {
var P_Q_inner_data = new Builder({module: 'builder', tlSchema:{"id": "-2083955988", "predicate": "p_q_inner_data", "params": [
var P_Q_inner_data = new Builder({module: 'mtproto', tlSchema:{"id": "-2083955988", "predicate": "p_q_inner_data", "params": [
{"name": "pq", "type": "bytes"},
{"name": "p", "type": "bytes"},
{"name": "q", "type": "bytes"},
Expand All @@ -25,16 +25,16 @@ describe('Builder', function () {
var obj = new P_Q_inner_data();
obj.should.be.an.instanceof(P_Q_inner_data);
obj.should.be.an.instanceof(AbstractObject);
obj.id.should.be.eql('-2083955988');
obj.typeName.should.be.eql('P_Q_inner_data');
obj.id.should.be.eql('ec5ac983');
obj.typeName.should.be.eql('mtproto.P_q_inner_data');

done();
})
});

describe('#buildTypeConstructor({ResPQ}).deserialize()', function () {
it('should build and de-serialize an instance of ResPQ', function (done) {
var ResPQ = new Builder({module: 'type_language/builder',tlSchema: {"id": "85337187", "predicate": "resPQ", "params": [
var ResPQ = new Builder({module: 'mtproto',tlSchema: {"id": "85337187", "predicate": "resPQ", "params": [
{"name": "nonce", "type": "int128"},
{"name": "server_nonce", "type": "int128"},
{"name": "pq", "type": "bytes"},
Expand All @@ -50,13 +50,13 @@ describe('Builder', function () {
obj.deserialize();
// console.log(obj);
obj.should.have.properties({
id: '85337187',
typeName: 'ResPQ',
id: '63241605',
typeName: 'mtproto.ResPQ',
nonce: '0xfce2ec8fa401b366e927ca8c8249053e',
server_nonce: '0x30739073a54aba77a81ea1f4334dcfa5'
});
obj.server_public_key_fingerprints.should.have.properties({
id: '481674261',
id: '15c4b51c',
type: 'Long',
_list: ['0xc3b42b026ce86b21']
});
Expand Down Expand Up @@ -89,7 +89,7 @@ describe('Builder', function () {
eql('632416053E0549828CCA27E966B301A48FECE2FCA5CF4D33F4A11EA877BA4AA5739073300817ED48941A08F98100000015C4B51C01000000216BE86C022BB4C3')

var obj2 = new ResPQ({buffer: objBuffer});
obj2.id.should.be.eql('85337187');
obj2.id.should.be.eql('63241605');

done();
})
Expand Down
6 changes: 3 additions & 3 deletions test/type_language/vector.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ describe('Vector', function () {
list.should.be.ok;
list.should.be.an.instanceof(Vector);
list.should.be.an.instanceof(AbstractObject);
list.should.have.properties({id: '481674261', type: 'Int'});
list.should.have.properties({id: '15c4b51c', type: 'Int'});
list.isReadonly().should.be.false;

var list = new Vector({type: 'long', buffer: new Buffer('15C4B51C01000000216BE86C022BB4C3', 'hex')});
list.should.have.properties({id: '481674261', type: 'Long'});
list.should.have.properties({id: '15c4b51c', type: 'Long'});
list.isReadonly().should.be.true;

var list = new Vector({type: 'long', list: [1,2,3]});
list.should.have.properties({id: '481674261', type: 'Long'});
list.should.have.properties({id: '15c4b51c', type: 'Long'});
list.isReadonly().should.be.false;
list.getList().should.be.eql([1,2,3]);

Expand Down

0 comments on commit bd676cb

Please sign in to comment.