mirrors/shlink-web-client
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink-web-client.git synced 2025-01-10 18:27:25 +03:00
Code Issues Projects Releases Packages Wiki Activity

Added stricter types for SemVer versions

Browse source
This commit is contained in:
Alejandro Celaya 2021-03-06 09:38:48 +01:00
parent b4c2fb5b8f
commit 70ce099913
7 changed files with 53 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/servers/data/index.ts
View file

@ -1,3 +1,5 @@
import { SemVer } from '../../utils/helpers/version';
export interface ServerData {
name: string;
url: string;
@ -9,7 +11,7 @@ export interface ServerWithId extends ServerData {
}
export interface ReachableServer extends ServerWithId {
version: string;
version: SemVer;
printableVersion: string;
}

16
src/utils/helpers/version.ts
View file

@ -2,12 +2,20 @@ import { compare } from 'compare-versions';
import { identity, memoizeWith } from 'ramda';
import { Empty, hasValue } from '../utils';
type SemVerPatternFragment = `${bigint | '*'}`;
export type SemVerPattern = SemVerPatternFragment
| `${SemVerPatternFragment}.${SemVerPatternFragment}`
| `${SemVerPatternFragment}.${SemVerPatternFragment}.${SemVerPatternFragment}`;
export interface Versions {
maxVersion?: string;
minVersion?: string;
maxVersion?: SemVerPattern;
minVersion?: SemVerPattern;
}
export const versionMatch = (versionToMatch: string | Empty, { maxVersion, minVersion }: Versions): boolean => {
export type SemVer = `${bigint}.${bigint}.${bigint}`;
export const versionMatch = (versionToMatch: SemVer | Empty, { maxVersion, minVersion }: Versions): boolean => {
if (!hasValue(versionToMatch)) {
return false;
}
@ -18,7 +26,7 @@ export const versionMatch = (versionToMatch: string | Empty, { maxVersion, minVe
return matchesMaxVersion && matchesMinVersion;
};
const versionIsValidSemVer = memoizeWith(identity, (version: string) => {
const versionIsValidSemVer = memoizeWith(identity, (version: string): version is SemVerPattern => {
try {
return compare(version, version, '=');
} catch (e) {

11
test/common/MenuLayout.test.tsx
View file

@ -6,6 +6,7 @@ import { Mock } from 'ts-mockery';
import createMenuLayout from '../../src/common/MenuLayout';
import { NonReachableServer, NotFoundServer, ReachableServer, SelectedServer } from '../../src/servers/data';
import NoMenuLayout from '../../src/common/NoMenuLayout';
import { SemVer } from '../../src/utils/helpers/version';
describe('<MenuLayout />', () => {
const ServerError = jest.fn();
@ -48,11 +49,11 @@ describe('<MenuLayout />', () => {
});
it.each([
[ '2.1.0', 6 ],
[ '2.2.0', 7 ],
[ '2.5.0', 7 ],
[ '2.6.0', 8 ],
[ '2.7.0', 8 ],
[ '2.1.0' as SemVer, 6 ],
[ '2.2.0' as SemVer, 7 ],
[ '2.5.0' as SemVer, 7 ],
[ '2.6.0' as SemVer, 8 ],
[ '2.7.0' as SemVer, 8 ],
])('has expected amount of routes based on selected server\'s version', (version, expectedAmountOfRoutes) => {
const selectedServer = Mock.of<ReachableServer>({ version });
const wrapper = createWrapper(selectedServer).dive();

10
test/common/ShlinkVersions.test.tsx
View file

@ -14,11 +14,11 @@ describe('<ShlinkVersions />', () => {
afterEach(() => wrapper?.unmount());
it.each([
[ '1.2.3', Mock.of<ReachableServer>({ version: '', printableVersion: 'foo' }), 'v1.2.3', 'foo' ],
[ 'foo', Mock.of<ReachableServer>({ version: '', printableVersion: '1.2.3' }), 'latest', '1.2.3' ],
[ 'latest', Mock.of<ReachableServer>({ version: '', printableVersion: 'latest' }), 'latest', 'latest' ],
[ '5.5.0', Mock.of<ReachableServer>({ version: '', printableVersion: '0.2.8' }), 'v5.5.0', '0.2.8' ],
[ 'not-semver', Mock.of<ReachableServer>({ version: '', printableVersion: 'something' }), 'latest', 'something' ],
[ '1.2.3', Mock.of<ReachableServer>({ version: '1.0.0', printableVersion: 'foo' }), 'v1.2.3', 'foo' ],
[ 'foo', Mock.of<ReachableServer>({ version: '1.0.0', printableVersion: '1.2.3' }), 'latest', '1.2.3' ],
[ 'latest', Mock.of<ReachableServer>({ version: '1.0.0', printableVersion: 'latest' }), 'latest', 'latest' ],
[ '5.5.0', Mock.of<ReachableServer>({ version: '1.0.0', printableVersion: '0.2.8' }), 'v5.5.0', '0.2.8' ],
[ 'not-semver', Mock.of<ReachableServer>({ version: '1.0.0', printableVersion: 'some' }), 'latest', 'some' ],
])(
'displays expected versions when selected server is reachable',
(clientVersion, selectedServer, expectedClientVersion, expectedServerVersion) => {

21
test/servers/helpers/ForServerVersion.test.tsx
View file

@ -2,11 +2,12 @@ import { mount, ReactWrapper } from 'enzyme';
import { Mock } from 'ts-mockery';
import ForServerVersion from '../../../src/servers/helpers/ForServerVersion';
import { ReachableServer, SelectedServer } from '../../../src/servers/data';
import { SemVer, SemVerPattern } from '../../../src/utils/helpers/version';
describe('<ForServerVersion />', () => {
let wrapped: ReactWrapper;
const renderComponent = (selectedServer: SelectedServer, minVersion?: string, maxVersion?: string) => {
const renderComponent = (selectedServer: SelectedServer, minVersion?: SemVerPattern, maxVersion?: SemVerPattern) => {
wrapped = mount(
<ForServerVersion minVersion={minVersion} maxVersion={maxVersion} selectedServer={selectedServer}>
<span>Hello</span>
@ -19,15 +20,15 @@ describe('<ForServerVersion />', () => {
afterEach(() => wrapped?.unmount());
it('does not render children when current server is empty', () => {
const wrapped = renderComponent(null, '1');
const wrapped = renderComponent(null, '1.*.*');
expect(wrapped.html()).toBeNull();
});
it.each([
[ '2.0.0', undefined, '1.8.3' ],
[ undefined, '1.8.0', '1.8.3' ],
[ '1.7.0', '1.8.0', '1.8.3' ],
[ '2.0.0' as SemVer, undefined, '1.8.3' as SemVer ],
[ undefined, '1.8.0' as SemVer, '1.8.3' as SemVer ],
[ '1.7.0' as SemVer, '1.8.0' as SemVer, '1.8.3' as SemVer ],
])('does not render children when current version does not match requirements', (min, max, version) => {
const wrapped = renderComponent(Mock.of<ReachableServer>({ version, printableVersion: version }), min, max);
@ -35,11 +36,11 @@ describe('<ForServerVersion />', () => {
});
it.each([
[ '2.0.0', undefined, '2.8.3' ],
[ '2.0.0', undefined, '2.0.0' ],
[ undefined, '1.8.0', '1.8.0' ],
[ undefined, '1.8.0', '1.7.1' ],
[ '1.7.0', '1.8.0', '1.7.3' ],
[ '2.0.0' as SemVer, undefined, '2.8.3' as SemVer ],
[ '2.0.0' as SemVer, undefined, '2.0.0' as SemVer ],
[ undefined, '1.8.0' as SemVer, '1.8.0' as SemVer ],
[ undefined, '1.8.0' as SemVer, '1.7.1' as SemVer ],
[ '1.7.0' as SemVer, '1.8.0' as SemVer, '1.7.3' as SemVer ],
])('renders children when current version matches requirements', (min, max, version) => {
const wrapped = renderComponent(Mock.of<ReachableServer>({ version, printableVersion: version }), min, max);

9
test/short-urls/ShortUrlsTable.test.tsx
View file

@ -5,6 +5,7 @@ import { ShortUrlsTable as shortUrlsTableCreator } from '../../src/short-urls/Sh
import { OrderableFields, SORTABLE_FIELDS } from '../../src/short-urls/reducers/shortUrlsListParams';
import { ShortUrlsList } from '../../src/short-urls/reducers/shortUrlsList';
import { ReachableServer, SelectedServer } from '../../src/servers/data';
import { SemVer } from '../../src/utils/helpers/version';
describe('<ShortUrlsTable />', () => {
let wrapper: ShallowWrapper;
@ -61,10 +62,10 @@ describe('<ShortUrlsTable />', () => {
});
it.each([
[ '2.6.0' ],
[ '2.6.1' ],
[ '2.7.0' ],
[ '3.0.0' ],
[ '2.6.0' as SemVer ],
[ '2.6.1' as SemVer ],
[ '2.7.0' as SemVer ],
[ '3.0.0' as SemVer ],
])('should render composed column when server supports title', (version) => {
const wrapper = createWrapper(Mock.of<ReachableServer>({ version }));
const composedColumn = wrapper.find('table').find('th').at(2);

21
test/short-urls/helpers/QrCodeModal.test.tsx
View file

@ -7,11 +7,12 @@ import { ShortUrl } from '../../../src/short-urls/data';
import { ReachableServer } from '../../../src/servers/data';
import { CopyToClipboardIcon } from '../../../src/utils/CopyToClipboardIcon';
import { DropdownBtn } from '../../../src/utils/DropdownBtn';
import { SemVer } from '../../../src/utils/helpers/version';
describe('<QrCodeModal />', () => {
let wrapper: ShallowWrapper;
const shortUrl = 'https://doma.in/abc123';
const createWrapper = (version = '2.6.0') => {
const createWrapper = (version: SemVer = '2.6.0') => {
const selectedServer = Mock.of<ReachableServer>({ version });
wrapper = shallow(
@ -37,12 +38,12 @@ describe('<QrCodeModal />', () => {
});
it.each([
[ '2.3.0', 0, '/qr-code/300' ],
[ '2.4.0', 0, '/qr-code/300?format=png' ],
[ '2.4.0', 10, '/qr-code/300?format=png' ],
[ '2.5.0', 0, '/qr-code?size=300&format=png' ],
[ '2.6.0', 0, '/qr-code?size=300&format=png' ],
[ '2.6.0', 10, '/qr-code?size=300&format=png&margin=10' ],
[ '2.3.0' as SemVer, 0, '/qr-code/300' ],
[ '2.4.0' as SemVer, 0, '/qr-code/300?format=png' ],
[ '2.4.0' as SemVer, 10, '/qr-code/300?format=png' ],
[ '2.5.0' as SemVer, 0, '/qr-code?size=300&format=png' ],
[ '2.6.0' as SemVer, 0, '/qr-code?size=300&format=png' ],
[ '2.6.0' as SemVer, 10, '/qr-code?size=300&format=png&margin=10' ],
])('displays an image with the QR code of the URL', (version, margin, expectedUrl) => {
const wrapper = createWrapper(version);
const formControls = wrapper.find('.form-control-range');
@ -84,9 +85,9 @@ describe('<QrCodeModal />', () => {
});
it.each([
[ '2.3.0', 0, 'col-12' ],
[ '2.4.0', 1, 'col-md-6' ],
[ '2.6.0', 1, 'col-md-4' ],
[ '2.3.0' as SemVer, 0, 'col-12' ],
[ '2.4.0' as SemVer, 1, 'col-md-6' ],
[ '2.6.0' as SemVer, 1, 'col-md-4' ],
])('shows expected components based on server version', (version, expectedAmountOfDropdowns, expectedRangeClass) => {
const wrapper = createWrapper(version);
const dropdown = wrapper.find(DropdownBtn);