Skip to content

os: refactor structure of the os module #12654

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

Closed
wants to merge 2 commits into from
Closed

os: refactor structure of the os module #12654

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05a78c2
os: refactor os structure, add Symbol.toPrimitive
jasnell Apr 25, 2017
854d7b7
test: remove extra console output from test-os.js
jasnell Apr 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
123 changes: 79 additions & 44 deletions lib/os.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,31 +21,50 @@

'use strict';

const binding = process.binding('os');
const getCPUs = binding.getCPUs;
const getLoadAvg = binding.getLoadAvg;
const pushValToArrayMax = process.binding('util').pushValToArrayMax;
const constants = process.binding('constants').os;
const internalUtil = require('internal/util');
const deprecate = require('internal/util').deprecate;
const isWindows = process.platform === 'win32';

exports.hostname = binding.getHostname;
exports.uptime = binding.getUptime;
exports.freemem = binding.getFreeMem;
exports.totalmem = binding.getTotalMem;
exports.type = binding.getOSType;
exports.release = binding.getOSRelease;
exports.networkInterfaces = binding.getInterfaceAddresses;
exports.homedir = binding.getHomeDirectory;
exports.userInfo = binding.getUserInfo;
const {
getCPUs,
getFreeMem,
getHomeDirectory,
getHostname,
getInterfaceAddresses,
getLoadAvg,
getOSRelease,
getOSType,
getTotalMem,
getUserInfo,
getUptime,
isBigEndian
} = process.binding('os');

getFreeMem[Symbol.toPrimitive] = () => getFreeMem();
getHostname[Symbol.toPrimitive] = () => getHostname();
getHomeDirectory[Symbol.toPrimitive] = () => getHomeDirectory();
getOSRelease[Symbol.toPrimitive] = () => getOSRelease();
getOSType[Symbol.toPrimitive] = () => getOSType();
getTotalMem[Symbol.toPrimitive] = () => getTotalMem();
getUptime[Symbol.toPrimitive] = () => getUptime();

const kEndianness = isBigEndian ? 'BE' : 'LE';

const tmpDirDeprecationMsg =
'os.tmpDir() is deprecated. Use os.tmpdir() instead.';

const getNetworkInterfacesDepMsg =
'os.getNetworkInterfaces is deprecated. Use os.networkInterfaces instead.';

const avgValues = new Float64Array(3);
exports.loadavg = function loadavg() {
const cpuValues = new Float64Array(6 * pushValToArrayMax);

function loadavg() {
getLoadAvg(avgValues);
return [avgValues[0], avgValues[1], avgValues[2]];
};
}

const cpuValues = new Float64Array(6 * pushValToArrayMax);
function addCPUInfo() {
for (var i = 0, c = 0; i < arguments.length; ++i, c += 6) {
this[this.length] = {
Expand All @@ -61,25 +80,22 @@ function addCPUInfo() {
};
}
}
exports.cpus = function cpus() {
return getCPUs(addCPUInfo, cpuValues, []);
};

Object.defineProperty(exports, 'constants', {
configurable: false,
enumerable: true,
value: constants
});
function cpus() {
return getCPUs(addCPUInfo, cpuValues, []);
}

exports.arch = function() {
function arch() {
return process.arch;
};
}
arch[Symbol.toPrimitive] = () => process.arch;

exports.platform = function() {
function platform() {
return process.platform;
};
}
platform[Symbol.toPrimitive] = () => process.platform;

exports.tmpdir = function() {
function tmpdir() {
var path;
if (isWindows) {
path = process.env.TEMP ||
Expand All @@ -97,22 +113,41 @@ exports.tmpdir = function() {
}

return path;
};
}
tmpdir[Symbol.toPrimitive] = () => tmpdir();

const tmpDirDeprecationMsg =
'os.tmpDir() is deprecated. Use os.tmpdir() instead.';
exports.tmpDir = internalUtil.deprecate(exports.tmpdir,
tmpDirDeprecationMsg,
'DEP0022');
function endianness() {
return kEndianness;
}
endianness[Symbol.toPrimitive] = () => kEndianness;

exports.getNetworkInterfaces = internalUtil.deprecate(function() {
return exports.networkInterfaces();
}, 'os.getNetworkInterfaces is deprecated. ' +
'Use os.networkInterfaces instead.', 'DEP0023');
module.exports = exports = {
arch,
cpus,
EOL: isWindows ? '\r\n' : '\n',
endianness,
freemem: getFreeMem,
homedir: getHomeDirectory,
hostname: getHostname,
loadavg,
networkInterfaces: getInterfaceAddresses,
platform,
release: getOSRelease,
tmpdir,
totalmem: getTotalMem,
type: getOSType,
userInfo: getUserInfo,
uptime: getUptime,

exports.EOL = isWindows ? '\r\n' : '\n';
// Deprecated APIs
getNetworkInterfaces: deprecate(getInterfaceAddresses,
getNetworkInterfacesDepMsg,
'DEP0023'),
tmpDir: deprecate(tmpdir, tmpDirDeprecationMsg, 'DEP0022')
};

if (binding.isBigEndian)
exports.endianness = function() { return 'BE'; };
else
exports.endianness = function() { return 'LE'; };
Object.defineProperty(module.exports, 'constants', {
configurable: false,
enumerable: true,
value: constants
});
19 changes: 9 additions & 10 deletions test/parallel/test-os.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,45 +70,37 @@ if (common.isWindows) {
}

const endianness = os.endianness();
console.log('endianness = %s', endianness);
is.string(endianness);
assert.ok(/[BL]E/.test(endianness));

const hostname = os.hostname();
console.log('hostname = %s', hostname);
is.string(hostname);
assert.ok(hostname.length > 0);

const uptime = os.uptime();
console.log('uptime = %d', uptime);
is.number(uptime);
assert.ok(uptime > 0);

const cpus = os.cpus();
console.log('cpus = ', cpus);
is.array(cpus);
assert.ok(cpus.length > 0);

const type = os.type();
console.log('type = ', type);
is.string(type);
assert.ok(type.length > 0);

const release = os.release();
console.log('release = ', release);
is.string(release);
assert.ok(release.length > 0);
//TODO: Check format on more than just AIX
if (common.isAix)
assert.ok(/^\d+\.\d+$/.test(release));

const platform = os.platform();
console.log('platform = ', platform);
is.string(platform);
assert.ok(platform.length > 0);

const arch = os.arch();
console.log('arch = ', arch);
is.string(arch);
assert.ok(arch.length > 0);

Expand All @@ -121,7 +113,6 @@ if (!common.isSunOS) {


const interfaces = os.networkInterfaces();
console.error(interfaces);
switch (platform) {
case 'linux':
{
Expand Down Expand Up @@ -151,7 +142,6 @@ assert.ok(EOL.length > 0);

const home = os.homedir();

console.log('homedir = ' + home);
is.string(home);
assert.ok(home.includes(path.sep));

Expand Down Expand Up @@ -191,3 +181,12 @@ is.string(pwd.username);
assert.ok(pwd.homedir.includes(path.sep));
assert.strictEqual(pwd.username, pwdBuf.username.toString('utf8'));
assert.strictEqual(pwd.homedir, pwdBuf.homedir.toString('utf8'));

// Test that the Symbol.toPrimitive functions work correctly
[
[`${os.hostname}`, os.hostname()],
[`${os.homedir}`, os.homedir()],
[`${os.release}`, os.release()],
[`${os.type}`, os.type()],
[`${os.endianness}`, os.endianness()]
].forEach((set) => assert.strictEqual(set[0], set[1]));