Move runtime settings back to adminApi from editorApi

Fixes #2662
This commit is contained in:
Nick O'Leary
2020-07-31 15:26:21 +01:00
parent a9d1a64c32
commit 16c26d8098
10 changed files with 252 additions and 100 deletions

View File

@@ -102,7 +102,7 @@ describe("api/admin/index", function() {
});
before(function() {
app = adminApi.init({});
app = adminApi.init({},{});
});
beforeEach(function() {

View File

@@ -0,0 +1,93 @@
/**
* Copyright JS Foundation and other contributors, http://js.foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**/
var should = require("should");
var request = require('supertest');
var express = require('express');
var bodyParser = require("body-parser");
var sinon = require('sinon');
var app;
var NR_TEST_UTILS = require("nr-test-utils");
var info = NR_TEST_UTILS.require("@node-red/editor-api/lib/admin/settings");
var theme = NR_TEST_UTILS.require("@node-red/editor-api/lib/editor/theme");
describe("api/editor/settings", function() {
before(function() {
sinon.stub(theme,"settings",function() { return { existing: 123, test: 456 };});
app = express();
app.use(bodyParser.json());
app.get("/settings",info.runtimeSettings);
});
after(function() {
theme.settings.restore();
});
it('returns the runtime settings', function(done) {
info.init({},{
settings: {
getRuntimeSettings: function(opts) {
return Promise.resolve({
a:1,
b:2,
editorTheme: { existing: 789 }
})
}
}
});
request(app)
.get("/settings")
.expect(200)
.end(function(err,res) {
if (err) {
return done(err);
}
res.body.should.have.property("a",1);
res.body.should.have.property("b",2);
res.body.should.have.property("editorTheme",{existing: 789, test:456});
done();
});
});
it('returns the runtime settings - disableEditor true', function(done) {
info.init({disableEditor: true},{
settings: {
getRuntimeSettings: function(opts) {
return Promise.resolve({
a:1,
b:2
})
}
}
});
request(app)
.get("/settings")
.expect(200)
.end(function(err,res) {
if (err) {
return done(err);
}
res.body.should.have.property("a",1);
res.body.should.have.property("b",2);
// no editorTheme if disabledEditor true
res.body.should.not.have.property("editorTheme");
done();
});
});
});

View File

@@ -32,7 +32,6 @@ describe("api/editor/settings", function() {
sinon.stub(theme,"settings",function() { return { existing: 123, test: 456 };});
app = express();
app.use(bodyParser.json());
app.get("/settings",info.runtimeSettings);
app.get("/settings/user",function(req,res,next) {req.user = "fred"; next()}, info.userSettings);
app.post("/settings/user",function(req,res,next) {req.user = "fred"; next()},info.updateUserSettings);
});
@@ -41,31 +40,6 @@ describe("api/editor/settings", function() {
theme.settings.restore();
});
it('returns the runtime settings', function(done) {
info.init({
settings: {
getRuntimeSettings: function(opts) {
return Promise.resolve({
a:1,
b:2,
editorTheme: { existing: 789 }
})
}
}
});
request(app)
.get("/settings")
.expect(200)
.end(function(err,res) {
if (err) {
return done(err);
}
res.body.should.have.property("a",1);
res.body.should.have.property("b",2);
res.body.should.have.property("editorTheme",{existing: 789, test:456});
done();
});
});
it('returns the user settings', function(done) {
info.init({
settings: {

View File

@@ -101,7 +101,58 @@ describe("runtime-api/settings", function() {
result.user.should.not.have.property("private");
})
});
it("gets the filtered settings when editor disabled ", function() {
settings.init({
settings: {
disableEditor: true,
foo: 123,
httpNodeRoot: "testHttpNodeRoot",
version: "testVersion",
paletteCategories :["red","blue","green"],
exportNodeSettings: (obj) => {
obj.testNodeSetting = "helloWorld";
}
},
nodes: {
listContextStores: () => { return {stores:["file","memory"], default: "file"} },
paletteEditorEnabled: () => false,
getCredentialKeyType: () => "test-key-type"
},
storage: {
projects: {
getActiveProject: () => 'test-active-project',
getFlowFilename: () => 'test-flow-file',
getCredentialsFilename: () => 'test-creds-file',
getGlobalGitUser: () => {return {name:'foo',email:'foo@example.com'}}
}
}
})
return settings.getRuntimeSettings({
user: {
username: "nick",
anonymous: false,
image: "http://example.com",
permissions: "*",
private: "secret"
}
}).then(result => {
result.should.have.property("user");
result.user.should.have.property("username","nick");
result.user.should.have.property("permissions","*");
result.user.should.have.property("image","http://example.com");
result.user.should.have.property("anonymous",false);
result.user.should.not.have.property("private");
// Filtered out when disableEditor is true
result.should.not.have.property("paletteCategories",["red","blue","green"]);
result.should.not.have.property("testNodeSetting","helloWorld");
result.should.not.have.property("foo",123);
result.should.not.have.property("flowEncryptionType","test-key-type");
result.should.not.have.property("project");
result.should.not.have.property("git");
})
});
it('includes project settings if projects available', function() {
settings.init({
settings: {