import { GENERIC_AVATAR, generateGravatarUrl } from '@verdaccio/utils'; import { DEFAULT_USER, DIST_TAGS } from '../../../../src/lib/constants'; import { logger, setup } from '../../../../src/lib/logger'; import { addGravatarSupport, formatAuthor, getVersion, getVersionFromTarball, getWebProtocol, isHTTPProtocol, normalizeDistTags, parseReadme, sortByName, } from '../../../../src/lib/utils'; import { getByQualityPriorityValue, spliceURL } from '../../../../src/utils/string'; setup([]); describe('Utilities', () => { const metadata: any = { name: 'npm_test', versions: { '1.0.0': { dist: { tarball: 'http://registry.org/npm_test/-/npm_test-1.0.0.tgz', }, }, '1.0.1': { dist: { tarball: 'http://registry.org/npm_test/-/npm_test-1.0.1.tgz', }, }, }, }; const cloneMetadata = (pkg = metadata) => Object.assign({}, pkg); describe('API utilities', () => { describe('Sort packages', () => { const packages = [ { name: 'ghc', }, { name: 'abc', }, { name: 'zxy', }, ]; test('should order ascending', () => { expect(sortByName(packages)).toEqual([ { name: 'abc', }, { name: 'ghc', }, { name: 'zxy', }, ]); }); test('should order descending', () => { expect(sortByName(packages, false)).toEqual([ { name: 'zxy', }, { name: 'ghc', }, { name: 'abc', }, ]); }); }); describe('getWebProtocol', () => { test('should handle undefined header', () => { expect(getWebProtocol(undefined, 'http')).toBe('http'); }); test('should handle emtpy string', () => { expect(getWebProtocol('', 'http')).toBe('http'); }); test('should have header priority over request protocol', () => { expect(getWebProtocol('https', 'http')).toBe('https'); }); test('should have handle empty protocol', () => { expect(getWebProtocol('https', '')).toBe('https'); }); test('should have handle invalid protocol', () => { expect(getWebProtocol('ftp', '')).toBe('http'); }); describe('getWebProtocol and HAProxy variant', () => { // https://github.com/verdaccio/verdaccio/issues/695 test('should handle http', () => { expect(getWebProtocol('http,http', 'https')).toBe('http'); }); test('should handle https', () => { expect(getWebProtocol('https,https', 'http')).toBe('https'); }); }); }); describe('normalizeDistTags', () => { test('should delete a invalid latest version', () => { const pkg = cloneMetadata(); pkg[DIST_TAGS] = { latest: '20000', }; normalizeDistTags(pkg); expect(Object.keys(pkg[DIST_TAGS])).toHaveLength(0); }); test('should define last published version as latest', () => { const pkg = cloneMetadata(); pkg[DIST_TAGS] = {}; normalizeDistTags(pkg); expect(pkg[DIST_TAGS]).toEqual({ latest: '1.0.1' }); }); test('should define last published version as latest with a custom dist-tag', () => { const pkg = cloneMetadata(); pkg[DIST_TAGS] = { beta: '1.0.1', }; normalizeDistTags(pkg); expect(pkg[DIST_TAGS]).toEqual({ beta: '1.0.1', latest: '1.0.1' }); }); test('should convert any array of dist-tags to a plain string', () => { const pkg = cloneMetadata(); pkg[DIST_TAGS] = { latest: ['1.0.1'], }; normalizeDistTags(pkg); expect(pkg[DIST_TAGS]).toEqual({ latest: '1.0.1' }); }); }); describe('getVersion', () => { test('should get the right version', () => { expect(getVersion(cloneMetadata(), '1.0.0')).toEqual(metadata.versions['1.0.0']); expect(getVersion(cloneMetadata(), 'v1.0.0')).toEqual(metadata.versions['1.0.0']); }); test('should return nothing on get non existing version', () => { expect(getVersion(cloneMetadata(), '0')).toBeUndefined(); expect(getVersion(cloneMetadata(), '2.0.0')).toBeUndefined(); expect(getVersion(cloneMetadata(), 'v2.0.0')).toBeUndefined(); expect(getVersion(cloneMetadata(), undefined)).toBeUndefined(); expect(getVersion(cloneMetadata(), null)).toBeUndefined(); expect(getVersion(cloneMetadata(), 2)).toBeUndefined(); }); }); describe('getVersionFromTarball', () => { test('should get the right version', () => { const simpleName = 'test-name-4.2.12.tgz'; const complexName = 'test-5.6.4-beta.2.tgz'; const otherComplexName = 'test-3.5.0-6.tgz'; expect(getVersionFromTarball(simpleName)).toEqual('4.2.12'); expect(getVersionFromTarball(complexName)).toEqual('5.6.4-beta.2'); expect(getVersionFromTarball(otherComplexName)).toEqual('3.5.0-6'); }); test("should don'n fall at incorrect tarball name", () => { expect(getVersionFromTarball('incorrectName')).toBeUndefined(); }); }); }); describe('String utilities', () => { test('should splice two strings and generate a url', () => { const url: string = spliceURL('http://domain.com', '/-/static/logo.png'); expect(url).toMatch('http://domain.com/-/static/logo.png'); }); test('should splice a empty strings and generate a url', () => { const url: string = spliceURL('', '/-/static/logo.png'); expect(url).toMatch('/-/static/logo.png'); }); test('should check HTTP protocol correctly', () => { expect(isHTTPProtocol('http://domain.com/-/static/logo.png')).toBeTruthy(); expect(isHTTPProtocol('https://www.domain.com/-/static/logo.png')).toBeTruthy(); expect(isHTTPProtocol('//domain.com/-/static/logo.png')).toBeTruthy(); expect(isHTTPProtocol('file:///home/user/logo.png')).toBeFalsy(); expect(isHTTPProtocol('file:///F:/home/user/logo.png')).toBeFalsy(); // Note that uses ftp protocol in src was deprecated in modern browsers expect(isHTTPProtocol('ftp://1.2.3.4/home/user/logo.png')).toBeFalsy(); expect(isHTTPProtocol('./logo.png')).toBeFalsy(); expect(isHTTPProtocol('.\\logo.png')).toBeFalsy(); expect(isHTTPProtocol('../logo.png')).toBeFalsy(); expect(isHTTPProtocol('..\\logo.png')).toBeFalsy(); expect(isHTTPProtocol('../../static/logo.png')).toBeFalsy(); expect(isHTTPProtocol('..\\..\\static\\logo.png')).toBeFalsy(); expect(isHTTPProtocol('logo.png')).toBeFalsy(); expect(isHTTPProtocol('.logo.png')).toBeFalsy(); expect(isHTTPProtocol('/static/logo.png')).toBeFalsy(); expect(isHTTPProtocol('F:\\static\\logo.png')).toBeFalsy(); }); test('getByQualityPriorityValue', () => { expect(getByQualityPriorityValue('')).toEqual(''); expect(getByQualityPriorityValue(null)).toEqual(''); expect(getByQualityPriorityValue(undefined)).toEqual(''); expect(getByQualityPriorityValue('something')).toEqual('something'); expect(getByQualityPriorityValue('something,')).toEqual('something'); expect(getByQualityPriorityValue('0,')).toEqual('0'); expect(getByQualityPriorityValue('application/json')).toEqual('application/json'); expect(getByQualityPriorityValue('application/json; q=1')).toEqual('application/json'); expect(getByQualityPriorityValue('application/json; q=')).toEqual('application/json'); expect(getByQualityPriorityValue('application/json;')).toEqual('application/json'); expect( getByQualityPriorityValue( 'application/json; q=1.0, application/vnd.npm.install-v1+json; q=0.9, */*' ) ).toEqual('application/json'); expect( getByQualityPriorityValue( 'application/json; q=1.0, application/vnd.npm.install-v1+json; q=, */*' ) ).toEqual('application/json'); expect( getByQualityPriorityValue( 'application/vnd.npm.install-v1+json; q=1.0, application/json; q=0.9, */*' ) ).toEqual('application/vnd.npm.install-v1+json'); expect( getByQualityPriorityValue( 'application/vnd.npm.install-v1+json; q=, application/json; q=0.9, */*' ) ).toEqual('application/json'); }); }); describe('User utilities', () => { test('should generate gravatar url with email', () => { const gravatarUrl: string = generateGravatarUrl('user@verdaccio.org'); expect(gravatarUrl).toMatch('https://www.gravatar.com/avatar/'); expect(gravatarUrl).not.toMatch('000000000'); }); test('should generate generic gravatar url', () => { const gravatarUrl: string = generateGravatarUrl(); expect(gravatarUrl).toMatch(GENERIC_AVATAR); }); }); describe('parseReadme', () => { test('should show error for no readme data', () => { const noData = ''; const spy = jest.spyOn(logger, 'info'); expect(parseReadme('testPackage', noData)).toEqual('ERROR: No README data found!'); expect(spy).toHaveBeenCalledWith( { packageName: 'testPackage' }, '@{packageName}: No readme found' ); }); }); describe('addGravatarSupport', () => { test('check for blank object', () => { // @ts-ignore expect(addGravatarSupport({})).toEqual({}); }); test('author, contributors and maintainers fields are not present', () => { const packageInfo = { latest: {}, }; // @ts-ignore expect(addGravatarSupport(packageInfo)).toEqual(packageInfo); }); test('author field is a blank object', () => { const packageInfo = { latest: { author: {} } }; // @ts-ignore expect(addGravatarSupport(packageInfo)).toEqual(packageInfo); }); test('author field is a string type', () => { const packageInfo = { latest: { author: 'user@verdccio.org' }, }; const result = { latest: { author: { author: 'user@verdccio.org', avatar: GENERIC_AVATAR, email: '', }, }, }; // @ts-ignore expect(addGravatarSupport(packageInfo)).toEqual(result); }); test('author field is an object type with author information', () => { const packageInfo = { latest: { author: { name: 'verdaccio', email: 'user@verdccio.org' } }, }; const result = { latest: { author: { avatar: 'https://www.gravatar.com/avatar/794d7f6ef93d0689437de3c3e48fadc7', email: 'user@verdccio.org', name: 'verdaccio', }, }, }; // @ts-ignore expect(addGravatarSupport(packageInfo)).toEqual(result); }); test('contributor field is a blank array', () => { const packageInfo = { latest: { contributors: [], }, }; // @ts-ignore expect(addGravatarSupport(packageInfo)).toEqual(packageInfo); }); describe('contributors', () => { test('contributors field has contributors', () => { const packageInfo = { latest: { contributors: [ { name: 'user', email: 'user@verdccio.org' }, { name: 'user1', email: 'user1@verdccio.org' }, ], }, }; const result = { latest: { contributors: [ { avatar: 'https://www.gravatar.com/avatar/794d7f6ef93d0689437de3c3e48fadc7', email: 'user@verdccio.org', name: 'user', }, { avatar: 'https://www.gravatar.com/avatar/51105a49ce4a9c2bfabf0f6a2cba3762', email: 'user1@verdccio.org', name: 'user1', }, ], }, }; // @ts-ignore expect(addGravatarSupport(packageInfo)).toEqual(result); }); test('contributors field is an object', () => { const packageInfo = { latest: { contributors: { name: 'user', email: 'user@verdccio.org' }, }, }; const result = { latest: { contributors: [ { avatar: 'https://www.gravatar.com/avatar/794d7f6ef93d0689437de3c3e48fadc7', email: 'user@verdccio.org', name: 'user', }, ], }, }; // @ts-ignore expect(addGravatarSupport(packageInfo)).toEqual(result); }); test('contributors field is a string', () => { const contributor = 'Barney Rubble (http://barnyrubble.tumblr.com/)'; const packageInfo = { latest: { contributors: contributor, }, }; const result = { latest: { contributors: [ { avatar: GENERIC_AVATAR, email: contributor, name: contributor, }, ], }, }; // @ts-ignore expect(addGravatarSupport(packageInfo)).toEqual(result); }); }); test('maintainers field is a blank array', () => { const packageInfo = { latest: { maintainers: [], }, }; // @ts-ignore expect(addGravatarSupport(packageInfo)).toEqual(packageInfo); }); test('maintainers field has maintainers', () => { const packageInfo = { latest: { maintainers: [ { name: 'user', email: 'user@verdccio.org' }, { name: 'user1', email: 'user1@verdccio.org' }, ], }, }; const result = { latest: { maintainers: [ { avatar: 'https://www.gravatar.com/avatar/794d7f6ef93d0689437de3c3e48fadc7', email: 'user@verdccio.org', name: 'user', }, { avatar: 'https://www.gravatar.com/avatar/51105a49ce4a9c2bfabf0f6a2cba3762', email: 'user1@verdccio.org', name: 'user1', }, ], }, }; // @ts-ignore expect(addGravatarSupport(packageInfo)).toEqual(result); }); }); describe('formatAuthor', () => { test('should check author field different values', () => { const author = 'verdaccioNpm'; expect(formatAuthor(author).name).toEqual(author); }); test('should check author field for object value', () => { const user = { name: 'Verdaccion NPM', email: 'verdaccio@verdaccio.org', url: 'https://verdaccio.org', }; expect(formatAuthor(user).url).toEqual(user.url); expect(formatAuthor(user).email).toEqual(user.email); expect(formatAuthor(user).name).toEqual(user.name); }); test('should check author field for other value', () => { expect(formatAuthor(null).name).toEqual(DEFAULT_USER); expect(formatAuthor({}).name).toEqual(DEFAULT_USER); expect(formatAuthor([]).name).toEqual(DEFAULT_USER); }); }); });