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.

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

Jump to bottom

Add helpful message about pooled classes #1664

Merged
merged 1 commit into from
Jun 24, 2014
Merged

Add helpful message about pooled classes #1664

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 29 additions & 12 deletions src/utils/PooledClass.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@

var invariant = require('invariant');

var ABOUT_POOLING_MESSAGE = null;
if (__DEV__) {
ABOUT_POOLING_MESSAGE = (
'This object is reused for performance reasons. If you\'re seeing this ' +
'after logging an object, try logging individual properties.'
);
}

/**
* Static poolers. Several custom versions for each potential number of
* arguments. A completely generic pooler is easy to implement, but would
Expand All @@ -29,46 +37,54 @@ var invariant = require('invariant');
*/
var oneArgumentPooler = function(copyFieldsFrom) {
var Klass = this;
var instance;
if (Klass.instancePool.length) {
var instance = Klass.instancePool.pop();
instance = Klass.instancePool.pop();
Klass.call(instance, copyFieldsFrom);
return instance;
} else {
return new Klass(copyFieldsFrom);
instance = new Klass(copyFieldsFrom);
}
instance._ABOUT_POOLING = null;
return instance;
};

var twoArgumentPooler = function(a1, a2) {
var Klass = this;
var instance;
if (Klass.instancePool.length) {
var instance = Klass.instancePool.pop();
instance = Klass.instancePool.pop();
Klass.call(instance, a1, a2);
return instance;
} else {
return new Klass(a1, a2);
instance = new Klass(a1, a2);
}
instance._ABOUT_POOLING = null;
return instance;
};

var threeArgumentPooler = function(a1, a2, a3) {
var Klass = this;
var instance;
if (Klass.instancePool.length) {
var instance = Klass.instancePool.pop();
instance = Klass.instancePool.pop();
Klass.call(instance, a1, a2, a3);
return instance;
} else {
return new Klass(a1, a2, a3);
instance = new Klass(a1, a2, a3);
}
instance._ABOUT_POOLING = null;
return instance;
};

var fiveArgumentPooler = function(a1, a2, a3, a4, a5) {
var Klass = this;
var instance;
if (Klass.instancePool.length) {
var instance = Klass.instancePool.pop();
instance = Klass.instancePool.pop();
Klass.call(instance, a1, a2, a3, a4, a5);
return instance;
} else {
return new Klass(a1, a2, a3, a4, a5);
instance = new Klass(a1, a2, a3, a4, a5);
}
instance._ABOUT_POOLING = null;
return instance;
};

var standardReleaser = function(instance) {
Expand All @@ -80,6 +96,7 @@ var standardReleaser = function(instance) {
if (instance.destructor) {
instance.destructor();
}
instance._ABOUT_POOLING = ABOUT_POOLING_MESSAGE;
if (Klass.instancePool.length < Klass.poolSize) {
Klass.instancePool.push(instance);
}
Expand Down