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

Move Validator to common module (#2651)

Browse Source
This commit is contained in:
Devin Binnie
2023-04-04 08:05:40 -04:00
committed by GitHub
parent e0a9527318
commit 112a591796
16 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

205
src/common/Validator.test.js Normal file
View File

@@ -0,0 +1,205 @@
// Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
'use strict';
import * as Validator from './Validator';
describe('common/Validator', () => {
describe('validateV0ConfigData', () => {
const config = {url: 'http://server-1.com'};
it('should return null when not provided object', () => {
expect(Validator.validateV0ConfigData('notanobject')).toBe(null);
});
it('should return complete object when it is valid', () => {
expect(Validator.validateV0ConfigData(config)).toStrictEqual(config);
});
it('should remove fields that arent part of the schema', () => {
const modifiedConfig = {...config, anotherField: 'value'};
expect(Validator.validateV0ConfigData(modifiedConfig)).toStrictEqual(config);
});
});
describe('validateV1ConfigData', () => {
const config = {
autostart: true,
enableHardwareAcceleration: true,
minimizeToTray: false,
showTrayIcon: false,
showUnreadBadge: true,
spellCheckerLocale: 'en-US',
teams: [
{
name: 'server-1',
url: 'http://server-1.com',
},
],
trayIconTheme: 'light',
useSpellChecker: true,
version: 1,
};
it('should remove invalid urls', () => {
const modifiedConfig = {
...config,
teams: [
...config.teams,
{
name: 'server-2',
url: 'a-bad>url',
},
],
};
expect(Validator.validateV1ConfigData(modifiedConfig)).toStrictEqual(config);
});
it('should clean URLs with backslashes', () => {
const modifiedConfig = {
...config,
teams: [
...config.teams,
{
name: 'server-2',
url: 'http:\\\\server-2.com\\subpath',
},
],
};
expect(Validator.validateV1ConfigData(modifiedConfig)).toStrictEqual({
...config,
teams: [
...config.teams,
{
name: 'server-2',
url: 'http://server-2.com/subpath',
},
],
});
});
it('should invalidate bad spell checker locales', () => {
const modifiedConfig = {
...config,
spellCheckerLocale: 'not-a-locale',
};
expect(Validator.validateV1ConfigData(modifiedConfig)).toStrictEqual(null);
});
});
describe('validateV2ConfigData', () => {
const config = {
autostart: true,
darkMode: false,
enableHardwareAcceleration: true,
minimizeToTray: false,
showTrayIcon: false,
showUnreadBadge: true,
spellCheckerLocale: 'en-US',
spellCheckerURL: 'http://spellcheckerservice.com',
teams: [
{
name: 'server-1',
url: 'http://server-1.com',
order: 1,
},
],
trayIconTheme: 'light',
useSpellChecker: true,
version: 2,
};
it('should remove invalid spellchecker URLs', () => {
const modifiedConfig = {
...config,
spellCheckerURL: 'a-bad>url',
};
expect(Validator.validateV2ConfigData(modifiedConfig)).not.toHaveProperty('spellCheckerURL');
});
});
describe('validateV3ConfigData', () => {
const config = {
autoCheckForUpdates: true,
autostart: true,
hideOnStart: false,
darkMode: false,
enableHardwareAcceleration: true,
startInFullscreen: false,
lastActiveTeam: 0,
logLevel: 'info',
minimizeToTray: false,
showTrayIcon: false,
showUnreadBadge: true,
spellCheckerLocales: ['en-US'],
spellCheckerURL: 'http://spellcheckerservice.com',
teams: [
{
lastActiveTab: 0,
name: 'server-1',
url: 'http://server-1.com',
order: 1,
tabs: [
{
name: 'tab-1',
isOpen: true,
},
],
},
],
trayIconTheme: 'use_system',
useSpellChecker: true,
version: 3,
};
it('should ensure messaging tab is open', () => {
const modifiedConfig = {
...config,
teams: [
{
...config.teams[0],
tabs: [
...config.teams[0].tabs,
{
name: 'TAB_MESSAGING',
isOpen: false,
},
],
},
],
};
expect(Validator.validateV3ConfigData(modifiedConfig)).toStrictEqual({
...config,
teams: [
{
...config.teams[0],
tabs: [
...config.teams[0].tabs,
{
name: 'TAB_MESSAGING',
isOpen: true,
},
],
},
],
});
});
});
describe('validateAllowedProtocols', () => {
const allowedProtocols = [
'spotify:',
'steam:',
'mattermost:',
];
it('should accept valid protocols', () => {
expect(Validator.validateAllowedProtocols(allowedProtocols)).toStrictEqual(allowedProtocols);
});
it('should reject invalid protocols', () => {
expect(Validator.validateAllowedProtocols([...allowedProtocols, 'not-a-protocol'])).toStrictEqual(null);
});
});
});

312
src/common/Validator.ts Normal file
View File

@@ -0,0 +1,312 @@
// Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
import log from 'electron-log';
import Joi from 'joi';
import {Args} from 'types/args';
import {AnyConfig, ConfigV0, ConfigV1, ConfigV2, ConfigV3, TeamWithTabs} from 'types/config';
import {DownloadedItems} from 'types/downloads';
import {SavedWindowState} from 'types/mainWindow';
import {AppState} from 'types/appState';
import {ComparableCertificate} from 'types/certificate';
import {PermissionType, TrustedOrigin} from 'types/trustedOrigin';
import {TAB_MESSAGING} from 'common/tabs/TabView';
import urlUtils from 'common/utils/url';
const defaultOptions = {
stripUnknown: true,
};
const defaultWindowWidth = 1000;
const defaultWindowHeight = 700;
const minWindowWidth = 400;
const minWindowHeight = 240;
const argsSchema = Joi.object<Args>({
hidden: Joi.boolean(),
disableDevMode: Joi.boolean(),
dataDir: Joi.string(),
version: Joi.boolean(),
fullscreen: Joi.boolean(),
});
const boundsInfoSchema = Joi.object<SavedWindowState>({
x: Joi.number().integer().default(0),
y: Joi.number().integer().default(0),
width: Joi.number().integer().min(minWindowWidth).required().default(defaultWindowWidth),
height: Joi.number().integer().min(minWindowHeight).required().default(defaultWindowHeight),
maximized: Joi.boolean().default(false),
fullscreen: Joi.boolean().default(false),
});
const appStateSchema = Joi.object<AppState>({
lastAppVersion: Joi.string(),
skippedVersion: Joi.string(),
updateCheckedDate: Joi.string(),
});
const downloadsSchema = Joi.object<DownloadedItems>().pattern(
Joi.string(),
{
type: Joi.string().valid('file', 'update'),
filename: Joi.string().allow(null),
state: Joi.string().valid('interrupted', 'progressing', 'completed', 'cancelled', 'deleted', 'available'),
progress: Joi.number().min(0).max(100),
location: Joi.string().allow(''),
mimeType: Joi.string().allow(null),
addedAt: Joi.number().min(0),
receivedBytes: Joi.number().min(0),
totalBytes: Joi.number().min(0),
bookmark: Joi.string(),
});
const configDataSchemaV0 = Joi.object<ConfigV0>({
url: Joi.string().required(),
});
const configDataSchemaV1 = Joi.object<ConfigV1>({
version: Joi.number().min(1).default(1),
teams: Joi.array().items(Joi.object({
name: Joi.string().required(),
url: Joi.string().required(),
})).default([]),
showTrayIcon: Joi.boolean().default(false),
trayIconTheme: Joi.any().allow('').valid('light', 'dark').default('light'),
minimizeToTray: Joi.boolean().default(false),
notifications: Joi.object({
flashWindow: Joi.any().valid(0, 2).default(0),
bounceIcon: Joi.boolean().default(false),
bounceIconType: Joi.any().allow('').valid('informational', 'critical').default('informational'),
}),
showUnreadBadge: Joi.boolean().default(true),
useSpellChecker: Joi.boolean().default(true),
enableHardwareAcceleration: Joi.boolean().default(true),
autostart: Joi.boolean().default(true),
spellCheckerLocale: Joi.string().regex(/^[a-z]{2}-[A-Z]{2}$/).default('en-US'),
});
const configDataSchemaV2 = Joi.object<ConfigV2>({
version: Joi.number().min(2).default(2),
teams: Joi.array().items(Joi.object({
name: Joi.string().required(),
url: Joi.string().required(),
order: Joi.number().integer().min(0),
})).default([]),
showTrayIcon: Joi.boolean().default(false),
trayIconTheme: Joi.any().allow('').valid('light', 'dark').default('light'),
minimizeToTray: Joi.boolean().default(false),
notifications: Joi.object({
flashWindow: Joi.any().valid(0, 2).default(0),
bounceIcon: Joi.boolean().default(false),
bounceIconType: Joi.any().allow('').valid('informational', 'critical').default('informational'),
}),
showUnreadBadge: Joi.boolean().default(true),
useSpellChecker: Joi.boolean().default(true),
enableHardwareAcceleration: Joi.boolean().default(true),
autostart: Joi.boolean().default(true),
spellCheckerLocale: Joi.string().default('en-US'),
spellCheckerURL: Joi.string().allow(null),
darkMode: Joi.boolean().default(false),
downloadLocation: Joi.string(),
});
const configDataSchemaV3 = Joi.object<ConfigV3>({
version: Joi.number().min(3).default(3),
teams: Joi.array().items(Joi.object({
name: Joi.string().required(),
url: Joi.string().required(),
order: Joi.number().integer().min(0),
lastActiveTab: Joi.number().integer().min(0).default(0),
tabs: Joi.array().items(Joi.object({
name: Joi.string().required(),
order: Joi.number().integer().min(0),
isOpen: Joi.boolean(),
})).default([]),
})).default([]),
showTrayIcon: Joi.boolean().default(false),
trayIconTheme: Joi.any().allow('').valid('light', 'dark', 'use_system').default('use_system'),
minimizeToTray: Joi.boolean().default(false),
notifications: Joi.object({
flashWindow: Joi.any().valid(0, 2).default(0),
bounceIcon: Joi.boolean().default(false),
bounceIconType: Joi.any().allow('').valid('informational', 'critical').default('informational'),
}),
showUnreadBadge: Joi.boolean().default(true),
useSpellChecker: Joi.boolean().default(true),
enableHardwareAcceleration: Joi.boolean().default(true),
startInFullscreen: Joi.boolean().default(false),
autostart: Joi.boolean().default(true),
hideOnStart: Joi.boolean().default(false),
spellCheckerLocales: Joi.array().items(Joi.string()).default([]),
spellCheckerURL: Joi.string().allow(null),
darkMode: Joi.boolean().default(false),
downloadLocation: Joi.string(),
lastActiveTeam: Joi.number().integer().min(0).default(0),
autoCheckForUpdates: Joi.boolean().default(true),
alwaysMinimize: Joi.boolean(),
alwaysClose: Joi.boolean(),
logLevel: Joi.string().default('info'),
appLanguage: Joi.string().allow(''),
});
// eg. data['community.mattermost.com'] = { data: 'certificate data', issuerName: 'COMODO RSA Domain Validation Secure Server CA'};
const certificateStoreSchema = Joi.object().pattern(
Joi.string().uri(),
Joi.object<ComparableCertificate>({
data: Joi.string(),
issuerName: Joi.string(),
}),
);
const originPermissionsSchema = Joi.object<TrustedOrigin>().keys({
canBasicAuth: Joi.boolean().default(false), // we can add more permissions later if we want
});
const trustedOriginsSchema = Joi.object({}).pattern(
Joi.string().uri(),
Joi.object().keys({
canBasicAuth: Joi.boolean().default(false), // we can add more permissions later if we want
}),
);
const allowedProtocolsSchema = Joi.array().items(Joi.string().regex(/^[a-z-]+:$/i));
// validate bounds_info.json
export function validateArgs(data: Args) {
return validateAgainstSchema(data, argsSchema);
}
// validate bounds_info.json
export function validateBoundsInfo(data: SavedWindowState) {
return validateAgainstSchema(data, boundsInfoSchema);
}
// validate app_state.json
export function validateAppState(data: AppState) {
return validateAgainstSchema(data, appStateSchema);
}
// validate downloads.json
export function validateDownloads(data: DownloadedItems) {
return validateAgainstSchema(data, downloadsSchema);
}
// validate v.0 config.json
export function validateV0ConfigData(data: ConfigV0) {
return validateAgainstSchema(data, configDataSchemaV0);
}
function cleanURL(url: string): string {
let updatedURL = url;
if (updatedURL.includes('\\')) {
updatedURL = updatedURL.toLowerCase().replace(/\\/gi, '/');
}
return updatedURL;
}
function cleanTeam<T extends {name: string; url: string}>(team: T) {
return {
...team,
url: cleanURL(team.url),
};
}
function cleanTeamWithTabs(team: TeamWithTabs) {
return {
...cleanTeam(team),
tabs: team.tabs.map((tab) => {
return {
...tab,
isOpen: tab.name === TAB_MESSAGING ? true : tab.isOpen,
};
}),
};
}
function cleanTeams<T extends {name: string; url: string}>(teams: T[], func: (team: T) => T) {
let newTeams = teams;
if (Array.isArray(newTeams) && newTeams.length) {
// first replace possible backslashes with forward slashes
newTeams = newTeams.map((team) => func(team));
// next filter out urls that are still invalid so all is not lost
newTeams = newTeams.filter(({url}) => urlUtils.isValidURL(url));
}
return newTeams;
}
// validate v.1 config.json
export function validateV1ConfigData(data: ConfigV1) {
data.teams = cleanTeams(data.teams, cleanTeam);
return validateAgainstSchema(data, configDataSchemaV1);
}
export function validateV2ConfigData(data: ConfigV2) {
data.teams = cleanTeams(data.teams, cleanTeam);
if (data.spellCheckerURL && !urlUtils.isValidURL(data.spellCheckerURL)) {
log.error('Invalid download location for spellchecker dictionary, removing from config');
delete data.spellCheckerURL;
}
return validateAgainstSchema(data, configDataSchemaV2);
}
export function validateV3ConfigData(data: ConfigV3) {
data.teams = cleanTeams(data.teams, cleanTeamWithTabs);
if (data.spellCheckerURL && !urlUtils.isValidURL(data.spellCheckerURL)) {
log.error('Invalid download location for spellchecker dictionary, removing from config');
delete data.spellCheckerURL;
}
return validateAgainstSchema(data, configDataSchemaV3);
}
export function validateConfigData(data: AnyConfig) {
switch (data.version) {
case 3:
return validateV3ConfigData(data)!;
case 2:
return validateV2ConfigData(data)!;
case 1:
return validateV1ConfigData(data)!;
default:
return validateV0ConfigData(data)!;
}
}
// validate certificate.json
export function validateCertificateStore(data: string | Record<string, ComparableCertificate>) {
const jsonData = (typeof data === 'object' ? data : JSON.parse(data));
return validateAgainstSchema(jsonData, certificateStoreSchema);
}
// validate allowedProtocols.json
export function validateAllowedProtocols(data: string[]) {
return validateAgainstSchema(data, allowedProtocolsSchema);
}
export function validateTrustedOriginsStore(data: string | Record<PermissionType, TrustedOrigin>) {
const jsonData: Record<PermissionType, TrustedOrigin> = (typeof data === 'object' ? data : JSON.parse(data));
return validateAgainstSchema(jsonData, trustedOriginsSchema);
}
export function validateOriginPermissions(data: string | TrustedOrigin) {
const jsonData: TrustedOrigin = (typeof data === 'object' ? data : JSON.parse(data));
return validateAgainstSchema(jsonData, originPermissionsSchema);
}
function validateAgainstSchema<T>(data: T, schema: Joi.ObjectSchema<T> | Joi.ArraySchema): T | null {
if (typeof data !== 'object') {
log.error(`Input 'data' is not an object we can validate: ${typeof data}`);
return null;
}
if (!schema) {
log.error('No schema provided to validate');
return null;
}
const {error, value} = schema.validate(data, defaultOptions);
if (error) {
log.error(`Validation failed due to: ${error}`);
return null;
}
return value;
}

2
src/common/config/index.test.js
View File

@@ -19,7 +19,7 @@ jest.mock('electron', () => ({
},
}));
jest.mock('main/Validator', () => ({
jest.mock('common/Validator', () => ({
validateV0ConfigData: (configData) => (configData.version === 0 ? configData : null),
validateV1ConfigData: (configData) => (configData.version === 1 ? configData : null),
validateV2ConfigData: (configData) => (configData.version === 2 ? configData : null),

5
src/common/config/index.ts
View File

@@ -21,12 +21,13 @@ import {
} from 'types/config';
import {UPDATE_TEAMS, GET_CONFIGURATION, UPDATE_CONFIGURATION, GET_LOCAL_CONFIGURATION, UPDATE_PATHS} from 'common/communication';
import * as Validator from 'common/Validator';
import {configPath} from 'main/constants';
import * as Validator from 'main/Validator';
import {getDefaultTeamWithTabsFromTeam} from 'common/tabs/TabView';
import Utils from 'common/utils/util';
import {configPath} from 'main/constants';
import defaultPreferences, {getDefaultDownloadLocation} from './defaultPreferences';
import upgradeConfigData from './upgradePreferences';
import buildConfig from './buildConfig';