frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
Code Issues Releases Wiki Activity

Do not rely on the HTML file to identify where nodes are registered from

Browse Source
This commit is contained in:
Nick O'Leary 2016-04-28 11:23:42 +01:00
parent 47316b0fb7
commit 45ff86eae5
5 changed files with 44 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
red/runtime/nodes/index.js
View File

@ -1,5 +1,5 @@
/** /**
* Copyright 2013, 2015 IBM Corp. * Copyright 2013, 2016 IBM Corp.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -33,15 +33,25 @@ var settings;
/** /**
* Registers a node constructor * Registers a node constructor
* @param nodeSet - the nodeSet providing the node (module/set)
* @param type - the string type name * @param type - the string type name
* @param constructor - the constructor function for this node type * @param constructor - the constructor function for this node type
* @param opts - optional additional options for the node * @param opts - optional additional options for the node
*/ */
function registerType(type,constructor,opts) { function registerType(nodeSet,type,constructor,opts) {
if (typeof type !== "string") {
// This is someone calling the api directly, rather than via the
// RED object provided to a node. Log a warning
log.warn("Deprecated call to RED.runtime.nodes.registerType - node-set name must be provided as first argument");
opts = constructor;
constructor = type;
type = nodeSet;
nodeSet = "";
}
if (opts && opts.credentials) { if (opts && opts.credentials) {
credentials.register(type,opts.credentials); credentials.register(type,opts.credentials);
} }
registry.registerType(type,constructor); registry.registerType(nodeSet,type,constructor);
} }
/** /**

5
red/runtime/nodes/registry/loader.js
View File

@ -71,7 +71,10 @@ function createNodeApi(node) {
util: runtime.util, util: runtime.util,
version: runtime.version, version: runtime.version,
} }
copyObjectProperties(runtime.nodes,red.nodes,["createNode","getNode","eachNode","registerType","addCredentials","getCredentials","deleteCredentials" ]); copyObjectProperties(runtime.nodes,red.nodes,["createNode","getNode","eachNode","addCredentials","getCredentials","deleteCredentials" ]);
red.nodes.registerType = function(type,constructor,opts) {
runtime.nodes.registerType(node.id,type,constructor,opts);
}
copyObjectProperties(runtime.log,red.log,null,["init"]); copyObjectProperties(runtime.log,red.log,null,["init"]);
copyObjectProperties(runtime.settings,red.settings,null,["init","load","reset"]); copyObjectProperties(runtime.settings,red.settings,null,["init","load","reset"]);
if (runtime.adminApi) { if (runtime.adminApi) {

15
red/runtime/nodes/registry/registry.js
View File

@ -1,5 +1,5 @@
/** /**
* Copyright 2015 IBM Corp. * Copyright 2015, 2016 IBM Corp.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -347,7 +347,7 @@ function inheritNode(constructor) {
} }
} }
function registerNodeConstructor(type,constructor) { function registerNodeConstructor(nodeSet,type,constructor) {
if (nodeConstructors[type]) { if (nodeConstructors[type]) {
throw new Error(type+" already registered"); throw new Error(type+" already registered");
} }
@ -358,6 +358,17 @@ function registerNodeConstructor(type,constructor) {
inheritNode(constructor); inheritNode(constructor);
} }
var nodeSetInfo = getFullNodeInfo(nodeSet);
if (nodeSetInfo) {
if (nodeSetInfo.types.indexOf(type) === -1) {
// A type is being registered for a known set, but for some reason
// we didn't spot it when parsing the HTML file.
// Registered a type is the definitive action - not the presence
// of an edit template. Ensure it is on the list of known types.
nodeSetInfo.types.push(type);
}
}
nodeConstructors[type] = constructor; nodeConstructors[type] = constructor;
events.emit("type-registered",type); events.emit("type-registered",type);
} }

12
test/red/runtime/nodes/registry/loader_spec.js
View File

@ -114,7 +114,8 @@ describe("red/nodes/registry/loader",function() {
registry.addNodeSet.lastCall.args[1].should.not.have.a.property('err'); registry.addNodeSet.lastCall.args[1].should.not.have.a.property('err');
nodes.registerType.calledOnce.should.be.true; nodes.registerType.calledOnce.should.be.true;
nodes.registerType.lastCall.args[0].should.eql('test-node-1'); nodes.registerType.lastCall.args[0].should.eql('node-red/TestNode1');
nodes.registerType.lastCall.args[1].should.eql('test-node-1');
done(); done();
}).otherwise(function(err) { }).otherwise(function(err) {
@ -162,8 +163,10 @@ describe("red/nodes/registry/loader",function() {
registry.addNodeSet.lastCall.args[1].should.not.have.a.property('err'); registry.addNodeSet.lastCall.args[1].should.not.have.a.property('err');
nodes.registerType.calledTwice.should.be.true; nodes.registerType.calledTwice.should.be.true;
nodes.registerType.firstCall.args[0].should.eql('test-node-multiple-1a'); nodes.registerType.firstCall.args[0].should.eql('node-red/MultipleNodes1');
nodes.registerType.secondCall.args[0].should.eql('test-node-multiple-1b'); nodes.registerType.firstCall.args[1].should.eql('test-node-multiple-1a');
nodes.registerType.secondCall.args[0].should.eql('node-red/MultipleNodes1');
nodes.registerType.secondCall.args[1].should.eql('test-node-multiple-1b');
done(); done();
}).otherwise(function(err) { }).otherwise(function(err) {
@ -212,7 +215,8 @@ describe("red/nodes/registry/loader",function() {
registry.addNodeSet.lastCall.args[1].should.not.have.a.property('err'); registry.addNodeSet.lastCall.args[1].should.not.have.a.property('err');
nodes.registerType.calledOnce.should.be.true; nodes.registerType.calledOnce.should.be.true;
nodes.registerType.lastCall.args[0].should.eql('test-node-2'); nodes.registerType.lastCall.args[0].should.eql('node-red/TestNode2');
nodes.registerType.lastCall.args[1].should.eql('test-node-2');
done(); done();
}).otherwise(function(err) { }).otherwise(function(err) {

12
test/red/runtime/nodes/registry/registry_spec.js
View File

@ -442,25 +442,25 @@ describe("red/nodes/registry/registry",function() {
events.emit.restore(); events.emit.restore();
}); });
it('registers a node constructor', function() { it('registers a node constructor', function() {
typeRegistry.registerNodeConstructor('node-type',TestNodeConstructor); typeRegistry.registerNodeConstructor('node-set','node-type',TestNodeConstructor);
events.emit.calledOnce.should.be.true; events.emit.calledOnce.should.be.true;
events.emit.lastCall.args[0].should.eql('type-registered'); events.emit.lastCall.args[0].should.eql('type-registered');
events.emit.lastCall.args[1].should.eql('node-type'); events.emit.lastCall.args[1].should.eql('node-type');
}) })
it('throws error on duplicate node registration', function() { it('throws error on duplicate node registration', function() {
typeRegistry.registerNodeConstructor('node-type',TestNodeConstructor); typeRegistry.registerNodeConstructor('node-set','node-type',TestNodeConstructor);
events.emit.calledOnce.should.be.true; events.emit.calledOnce.should.be.true;
events.emit.lastCall.args[0].should.eql('type-registered'); events.emit.lastCall.args[0].should.eql('type-registered');
events.emit.lastCall.args[1].should.eql('node-type'); events.emit.lastCall.args[1].should.eql('node-type');
/*jshint immed: false */ /*jshint immed: false */
(function(){ (function(){
typeRegistry.registerNodeConstructor('node-type',TestNodeConstructor); typeRegistry.registerNodeConstructor('node-set','node-type',TestNodeConstructor);
}).should.throw("node-type already registered"); }).should.throw("node-type already registered");
events.emit.calledOnce.should.be.true; events.emit.calledOnce.should.be.true;
}); });
it('extends a constructor with the Node constructor', function() { it('extends a constructor with the Node constructor', function() {
TestNodeConstructor.prototype.should.not.be.an.instanceOf(Node); TestNodeConstructor.prototype.should.not.be.an.instanceOf(Node);
typeRegistry.registerNodeConstructor('node-type',TestNodeConstructor); typeRegistry.registerNodeConstructor('node-set','node-type',TestNodeConstructor);
TestNodeConstructor.prototype.should.be.an.instanceOf(Node); TestNodeConstructor.prototype.should.be.an.instanceOf(Node);
}); });
it('does not override a constructor\'s prototype', function() { it('does not override a constructor\'s prototype', function() {
@ -469,12 +469,12 @@ describe("red/nodes/registry/registry",function() {
TestNodeConstructor.prototype.should.be.an.instanceOf(Foo); TestNodeConstructor.prototype.should.be.an.instanceOf(Foo);
TestNodeConstructor.prototype.should.not.be.an.instanceOf(Node); TestNodeConstructor.prototype.should.not.be.an.instanceOf(Node);
typeRegistry.registerNodeConstructor('node-type',TestNodeConstructor); typeRegistry.registerNodeConstructor('node-set','node-type',TestNodeConstructor);
TestNodeConstructor.prototype.should.be.an.instanceOf(Node); TestNodeConstructor.prototype.should.be.an.instanceOf(Node);
TestNodeConstructor.prototype.should.be.an.instanceOf(Foo); TestNodeConstructor.prototype.should.be.an.instanceOf(Foo);
typeRegistry.registerNodeConstructor('node-type2',TestNodeConstructor); typeRegistry.registerNodeConstructor('node-set','node-type2',TestNodeConstructor);
TestNodeConstructor.prototype.should.be.an.instanceOf(Node); TestNodeConstructor.prototype.should.be.an.instanceOf(Node);
TestNodeConstructor.prototype.should.be.an.instanceOf(Foo); TestNodeConstructor.prototype.should.be.an.instanceOf(Foo);
}); });