phlux/mattermostest
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #633 from yuya-oc/simplify-two-config

Browse Source 
Simplify and split config.json into defaultPreferences and buildConfig
This commit is contained in:
Yuya Ochiai
2017-11-09 00:49:09 +09:00
committed by GitHub
parent 992828fea7 fdf0d51442
commit 3a865f3d24
22 changed files with 212 additions and 177 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/browser/components/SettingsPage.jsx
View File

@@ -8,6 +8,7 @@ const {ipcRenderer, remote} = require('electron');
const AutoLaunch = require('auto-launch');
const {debounce} = require('underscore');
const buildConfig = require('../../common/config/buildConfig');
const settings = require('../../common/settings');
const TeamList = require('./TeamList.jsx');
@@ -29,7 +30,8 @@ const CONFIG_TYPE_APP_OPTIONS = 'appOptions';
const SettingsPage = createReactClass({
propTypes: {
configFile: PropTypes.string
configFile: PropTypes.string,
enableServerManagement: PropTypes.bool
},
getInitialState() {
@@ -301,8 +303,10 @@ const SettingsPage = createReactClass({
onTeamsChange={this.handleTeamsChange}
updateTeam={this.updateTeam}
addServer={this.addServer}
onTeamClick={backToIndex}
allowTeamEdit={this.state.enableTeamModification}
onTeamClick={(index) => {
backToIndex(index + buildConfig.defaultTeams.length);
}}
/>
</Col>
</Row>
@@ -339,7 +343,7 @@ const SettingsPage = createReactClass({
);
var srvMgmt;
if (this.state.enableServerManagement || this.state.teams.length === 0) {
if (this.props.enableServerManagement === true) {
srvMgmt = (
<div>
{serversRow}
@@ -514,7 +518,7 @@ const SettingsPage = createReactClass({
bsStyle='link'
style={settingsPage.close}
onClick={this.handleCancel}
disabled={this.state.teams.length === 0}
disabled={settings.mergeDefaultTeams(this.state.teams).length === 0}
>
<span>{'×'}</span>
</Button>

15
src/browser/index.jsx
View File

@@ -12,14 +12,18 @@ const {remote, ipcRenderer} = require('electron');
const MainPage = require('./components/MainPage.jsx');
const AppConfig = require('./config/AppConfig.js');
const buildConfig = require('../common/config/buildConfig');
const settings = require('../common/settings');
const url = require('url');
const badge = require('./js/badge');
const utils = require('../utils/util');
const teams = settings.mergeDefaultTeams(AppConfig.data.teams);
remote.getCurrentWindow().removeAllListeners('focus');
if (AppConfig.data.teams.length === 0) {
if (teams.length === 0) {
window.location = 'settings.html';
}
@@ -90,8 +94,9 @@ function showUnreadBadge(unreadCount, mentionCount) {
const permissionRequestQueue = [];
const requestingPermission = new Array(AppConfig.data.teams.length);
function teamConfigChange(teams) {
AppConfig.set('teams', teams);
function teamConfigChange(updatedTeams) {
AppConfig.set('teams', updatedTeams.slice(buildConfig.defaultTeams.length));
teams.splice(0, teams.length, ...updatedTeams);
requestingPermission.length = teams.length;
ipcRenderer.send('update-menu', AppConfig.data);
ipcRenderer.send('update-config');
@@ -157,14 +162,14 @@ if (!parsedURL.query.index || parsedURL.query.index === null) {
ReactDOM.render(
<MainPage
teams={AppConfig.data.teams}
teams={teams}
initialIndex={initialIndex}
onUnreadCountChange={showUnreadBadge}
onTeamConfigChange={teamConfigChange}
useSpellChecker={AppConfig.data.useSpellChecker}
onSelectSpellCheckerLocale={handleSelectSpellCheckerLocale}
deeplinkingUrl={deeplinkingUrl}
showAddServerButton={AppConfig.data.enableServerManagement}
showAddServerButton={buildConfig.enableServerManagement}
requestingPermission={requestingPermission}
onClickPermissionDialog={handleClickPermissionDialog}
/>,

6
src/browser/settings.jsx
View File

@@ -9,13 +9,17 @@ const React = require('react');
const ReactDOM = require('react-dom');
const SettingsPage = require('./components/SettingsPage.jsx');
const contextMenu = require('./js/contextMenu');
const buildConfig = require('../common/config/buildConfig');
const configFile = remote.app.getPath('userData') + '/config.json';
contextMenu.setup(remote.getCurrentWindow());
ReactDOM.render(
<SettingsPage configFile={configFile}/>,
<SettingsPage
configFile={configFile}
enableServerManagement={buildConfig.enableServerManagement}
/>,
document.getElementById('content')
);

32
src/common/config/base.json
View File

@@ -1,32 +0,0 @@
{
"default": {
"teams": [],
"showTrayIcon": false,
"trayIconTheme": "light",
"minimizeToTray": false,
"version": 1,
"notifications": {
"flashWindow": 0
},
"showUnreadBadge": true,
"useSpellChecker": true,
"spellCheckerLocale": "en-US",
"helpLink": "https://docs.mattermost.com/help/apps/desktop-guide.html",
"enableServerManagement": true
},
"1": {
"teams": [],
"showTrayIcon": false,
"trayIconTheme": "light",
"minimizeToTray": false,
"version": 1,
"notifications": {
"flashWindow": 0
},
"showUnreadBadge": true,
"useSpellChecker": true,
"spellCheckerLocale": "en-US",
"helpLink": "https://docs.mattermost.com/help/apps/desktop-guide.html",
"enableServerManagement": true
}
}

23
src/common/config/buildConfig.js Normal file
View File

@@ -0,0 +1,23 @@
/**
* Build-time configuration. End-users can't change these parameters.
* @prop {Object[]} defaultTeams
* @prop {string} defaultTeams[].name - The tab name for default team.
* @prop {string} defaultTeams[].url - The URL for default team.
* @prop {string} helpLink - The URL for "Help->Learn More..." menu item.
* If null is specified, the menu disappears.
* @prop {boolean} enableServerManagement - Whether users can edit servers configuration.
* Specify at least one server for "defaultTeams"
* when "enableServerManagement is set to false
*/
const buildConfig = {
defaultTeams: [/*
{
name: 'example',
url: 'https://example.com'
}*/
],
helpLink: 'https://docs.mattermost.com/help/apps/desktop-guide.html',
enableServerManagement: true
};
module.exports = buildConfig;

19
src/common/config/defaultPreferences.js Normal file
View File

@@ -0,0 +1,19 @@
/**
* Default user preferences. End-users can change these parameters by editing config.json
* @param {number} version - Scheme version. (Not application version)
*/
const defaultPreferences = {
version: 1,
teams: [],
showTrayIcon: false,
trayIconTheme: 'light',
minimizeToTray: false,
notifications: {
flashWindow: 0
},
showUnreadBadge: true,
useSpellChecker: true,
spellCheckerLocale: 'en-US'
};
module.exports = defaultPreferences;

3
src/common/config/override.json
View File

@@ -1,3 +0,0 @@
{
}

11
src/common/config/pastDefaultPreferences.js Normal file
View File

@@ -0,0 +1,11 @@
const defaultPreferences = require('./defaultPreferences');
const pastDefaultPreferences = {
0: {
url: ''
}
};
pastDefaultPreferences[`${defaultPreferences.version}`] = defaultPreferences;
module.exports = pastDefaultPreferences;

29
src/common/config/upgradePreferences.js Normal file
View File

@@ -0,0 +1,29 @@
const pastDefaultPreferences = require('./pastDefaultPreferences');
function deepCopy(object) {
return JSON.parse(JSON.stringify(object));
}
function upgradeV0toV1(configV0) {
const config = deepCopy(pastDefaultPreferences['1']);
if (config.version !== 1) {
throw new Error('pastDefaultPreferences[\'1\'].version is not equal to 1');
}
config.teams.push({
name: 'Primary team',
url: configV0.url
});
return config;
}
function upgradeToLatest(config) {
var configVersion = config.version ? config.version : 0;
switch (configVersion) {
case 0:
return upgradeToLatest(upgradeV0toV1(config));
default:
return config;
}
}
module.exports = upgradeToLatest;

87
src/common/settings.js
View File

@@ -1,90 +1,56 @@
'use strict';
const fs = require('fs');
const path = require('path');
const deepmerge = require('./deepmerge');
const settingsVersion = 1;
const baseConfig = require('./config/base.json');
const overrideConfig = require('./config/override.json');
const buildConfig = require('./config/buildConfig');
function merge(base, target) {
return Object.assign({}, base, target);
}
function deepMergeArray(source, dest) {
return dest;
}
const defaultPreferences = require('./config/defaultPreferences');
const upgradePreferences = require('./config/upgradePreferences');
function loadDefault(version, spellCheckerLocale) {
var ver = version;
if (version == null) {
ver = settingsVersion;
}
const base = baseConfig[ver] || baseConfig.default;
const override = overrideConfig[ver] || {};
const defaults = deepmerge(base, override, {arrayMerge: deepMergeArray});
return Object.assign(defaults, {
spellCheckerLocale: spellCheckerLocale || defaults.spellCheckerLocale || 'en-US'
function loadDefault(spellCheckerLocale) {
const config = JSON.parse(JSON.stringify(defaultPreferences));
return Object.assign({}, config, {
spellCheckerLocale: spellCheckerLocale || defaultPreferences.pellCheckerLocale || 'en-US'
});
}
function upgradeV0toV1(configV0) {
var config = loadDefault(1);
config.teams.push({
name: 'Primary team',
url: configV0.url
});
return config;
function hasBuildConfigDefaultTeams(config) {
return config.defaultTeams.length > 0;
}
function upgrade(config, newAppVersion) {
var configVersion = config.version ? config.version : 0;
if (newAppVersion) {
config.lastMattermostVersion = newAppVersion;
}
switch (configVersion) {
case 0:
return upgrade(upgradeV0toV1(config));
default:
return config;
}
function upgrade(config) {
return upgradePreferences(config);
}
module.exports = {
version: settingsVersion,
version: defaultPreferences.version,
upgrade,
readFileSync(configFile) {
var config = JSON.parse(fs.readFileSync(configFile, 'utf8'));
// need to be able to compare 1 to '1'
if (config.version == settingsVersion) { // eslint-disable-line
var defaultConfig = this.loadDefault();
config = merge(defaultConfig, config);
const config = JSON.parse(fs.readFileSync(configFile, 'utf8'));
if (config.version === defaultPreferences.version) {
const defaultConfig = loadDefault();
return merge(defaultConfig, config);
}
return config;
},
writeFile(configFile, config, callback) {
// need to be able to compare 1 to '1'
if (config.version != settingsVersion) { // eslint-disable-line
throw new Error('version ' + config.version + ' is not equal to ' + settingsVersion);
if (config.version !== defaultPreferences.version) {
throw new Error('version ' + config.version + ' is not equal to ' + defaultPreferences.version);
}
var data = JSON.stringify(config, null, ' ');
fs.writeFile(configFile, data, 'utf8', callback);
},
writeFileSync(configFile, config) {
// need to be able to compare 1 to '1'
if (config.version != settingsVersion) { // eslint-disable-line
throw new Error('version ' + config.version + ' is not equal to ' + settingsVersion);
if (config.version !== defaultPreferences.version) {
throw new Error('version ' + config.version + ' is not equal to ' + defaultPreferences.version);
}
const dir = path.dirname(configFile);
@@ -96,5 +62,16 @@ module.exports = {
fs.writeFileSync(configFile, data, 'utf8');
},
loadDefault
loadDefault,
mergeDefaultTeams(teams) {
const newTeams = [];
if (hasBuildConfigDefaultTeams(buildConfig)) {
newTeams.push(...JSON.parse(JSON.stringify(buildConfig.defaultTeams)));
}
if (buildConfig.enableServerManagement) {
newTeams.push(...JSON.parse(JSON.stringify(teams)));
}
return newTeams;
}
};

2
src/main.js
View File

@@ -69,7 +69,7 @@ try {
config = settings.readFileSync(configFile);
if (config.version !== settings.version || wasUpdated()) {
clearAppCache();
config = settings.upgrade(config, app.getVersion());
config = settings.upgrade(config);
settings.writeFileSync(configFile, config);
}
} catch (e) {

15
src/main/menus/app.js
View File

@@ -1,6 +1,8 @@
'use strict';
const electron = require('electron');
const settings = require('../../common/settings');
const buildConfig = require('../../common/config/buildConfig');
const Menu = electron.Menu;
@@ -38,7 +40,7 @@ function createTemplate(mainWindow, config, isDev) {
}
}];
if (config.enableServerManagement === true || config.teams.length === 0) {
if (buildConfig.enableServerManagement === true) {
platformAppMenu.push({
label: 'Sign in to Another Server',
click() {
@@ -173,13 +175,14 @@ function createTemplate(mainWindow, config, isDev) {
}]
});
const teams = settings.mergeDefaultTeams(config.teams);
const windowMenu = {
label: '&Window',
submenu: [{
role: 'minimize'
}, {
role: 'close'
}, separatorItem, ...config.teams.slice(0, 9).map((team, i) => {
}, separatorItem, ...teams.slice(0, 9).map((team, i) => {
return {
label: team.name,
accelerator: `CmdOrCtrl+${i + 1}`,
@@ -194,23 +197,23 @@ function createTemplate(mainWindow, config, isDev) {
click() {
mainWindow.webContents.send('select-next-tab');
},
enabled: (config.teams.length > 1)
enabled: (teams.length > 1)
}, {
label: 'Select Previous Server',
accelerator: 'Ctrl+Shift+Tab',
click() {
mainWindow.webContents.send('select-previous-tab');
},
enabled: (config.teams.length > 1)
enabled: (teams.length > 1)
}]
};
template.push(windowMenu);
var submenu = [];
if (config.helpLink) {
if (buildConfig.helpLink) {
submenu.push({
label: 'Learn More...',
click() {
electron.shell.openExternal(config.helpLink);
electron.shell.openExternal(buildConfig.helpLink);
}
});
submenu.push(separatorItem);

4
src/main/menus/tray.js
View File

@@ -4,11 +4,13 @@ const {
app,
Menu
} = require('electron');
const settings = require('../../common/settings');
function createTemplate(mainWindow, config, isDev) {
const settingsURL = isDev ? 'http://localhost:8080/browser/settings.html' : `file://${app.getAppPath()}/browser/settings.html`;
const teams = settings.mergeDefaultTeams(config.teams);
var template = [
...config.teams.slice(0, 9).map((team, i) => {
...teams.slice(0, 9).map((team, i) => {
return {
label: team.name,
click: () => {

1
src/package.json
View File

@@ -12,7 +12,6 @@
"auto-launch": "^5.0.1",
"bootstrap": "^3.3.7",
"create-react-class": "^15.6.2",
"deepmerge": "^1.5.2",
"electron-context-menu": "^0.9.0",
"electron-devtools-installer": "^2.2.1",
"electron-is-dev": "^0.3.0",

4
src/yarn.lock
View File

@@ -141,10 +141,6 @@ decamelize@^1.1.1:
version "1.2.0"
resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290"
deepmerge@^1.5.2:
version "1.5.2"
resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-1.5.2.tgz#10499d868844cdad4fee0842df8c7f6f0c95a753"
dom-helpers@^3.2.0, dom-helpers@^3.2.1:
version "3.2.1"
resolved "https://registry.yarnpkg.com/dom-helpers/-/dom-helpers-3.2.1.tgz#3203e07fed217bd1f424b019735582fc37b2825a"