From f5641fe6d641442b2cb6935ede00eb41f8ad07c4 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 10 Apr 2018 11:38:00 -0400 Subject: [PATCH 01/24] Add `link-text` dependency It only has the minimum required dependencies: - `linkify-it`: Best-in-class link detection library with support for Unicode/IDN. - `escape-html`: Standalone dependency for escaping HTML. - `uc.micro`: Standalone dependency of Unicode data files. --- package.json | 1 + yarn.lock | 19 ++++++++++++++++++- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index b6c5f7950..250d17d0b 100644 --- a/package.json +++ b/package.json @@ -71,6 +71,7 @@ "fs-extra": "^5.0.0", "google-libphonenumber": "^3.0.7", "got": "^8.2.0", + "link-text": "^0.0.1", "lodash": "^4.17.4", "mkdirp": "^0.5.1", "moment": "^2.21.0", diff --git a/yarn.lock b/yarn.lock index a37b192e2..f9f512aff 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2733,7 +2733,7 @@ es6-promisify@^5.0.0: dependencies: es6-promise "^4.0.3" -escape-html@~1.0.3: +escape-html@^1.0.3, escape-html@~1.0.3: version "1.0.3" resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988" @@ -5151,6 +5151,19 @@ lie@*: dependencies: immediate "~3.0.5" +link-text@^0.0.1: + version "0.0.1" + resolved "https://registry.yarnpkg.com/link-text/-/link-text-0.0.1.tgz#d185042f4ec3eda07af7aeb773ab7f7cbd18adc2" + dependencies: + escape-html "^1.0.3" + linkify-it "^1.2.0" + +linkify-it@^1.2.0: + version "1.2.4" + resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-1.2.4.tgz#0773526c317c8fd13bd534ee1d180ff88abf881a" + dependencies: + uc.micro "^1.0.1" + listify@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/listify/-/listify-1.0.0.tgz#03ca7ba2d150d4267773f74e57558d1053d2bee3" @@ -8937,6 +8950,10 @@ ua-parser-js@^0.7.9: version "0.7.17" resolved "https://registry.yarnpkg.com/ua-parser-js/-/ua-parser-js-0.7.17.tgz#e9ec5f9498b9ec910e7ae3ac626a805c4d09ecac" +uc.micro@^1.0.1: + version "1.0.5" + resolved "https://registry.yarnpkg.com/uc.micro/-/uc.micro-1.0.5.tgz#0c65f15f815aa08b560a61ce8b4db7ffc3f45376" + uglify-es@^3.3.4: version "3.3.9" resolved "https://registry.yarnpkg.com/uglify-es/-/uglify-es-3.3.9.tgz#0c1c4f0700bed8dbc124cdb304d2592ca203e677" From 78ba4eddc1c3f38ad1f563e57ba6cbe501b4b39d Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 10 Apr 2018 12:06:53 -0400 Subject: [PATCH 02/24] Add `@types/lodash` --- package.json | 1 + yarn.lock | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/package.json b/package.json index 250d17d0b..b498907d4 100644 --- a/package.json +++ b/package.json @@ -92,6 +92,7 @@ "websocket": "^1.0.25" }, "devDependencies": { + "@types/lodash": "^4.14.106", "@types/qs": "^6.5.1", "@types/react": "^16.3.1", "@types/react-dom": "^16.0.4", diff --git a/yarn.lock b/yarn.lock index f9f512aff..350146582 100644 --- a/yarn.lock +++ b/yarn.lock @@ -36,6 +36,10 @@ dependencies: samsam "1.3.0" +"@types/lodash@^4.14.106": + version "4.14.106" + resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.106.tgz#6093e9a02aa567ddecfe9afadca89e53e5dce4dd" + "@types/node@*": version "9.6.1" resolved "https://registry.yarnpkg.com/@types/node/-/node-9.6.1.tgz#e2d374ef15b315b48e7efc308fa1a7cd51faa06c" From 7ac4bee9591d5b76c8a80c28863100ae630b2d6d Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Mon, 9 Apr 2018 20:01:30 -0400 Subject: [PATCH 03/24] Add `@types/chai` --- package.json | 1 + yarn.lock | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/package.json b/package.json index b498907d4..fa0567c99 100644 --- a/package.json +++ b/package.json @@ -92,6 +92,7 @@ "websocket": "^1.0.25" }, "devDependencies": { + "@types/chai": "^4.1.2", "@types/lodash": "^4.14.106", "@types/qs": "^6.5.1", "@types/react": "^16.3.1", diff --git a/yarn.lock b/yarn.lock index 350146582..40be0bbc4 100644 --- a/yarn.lock +++ b/yarn.lock @@ -36,6 +36,10 @@ dependencies: samsam "1.3.0" +"@types/chai@^4.1.2": + version "4.1.2" + resolved "https://registry.yarnpkg.com/@types/chai/-/chai-4.1.2.tgz#f1af664769cfb50af805431c407425ed619daa21" + "@types/lodash@^4.14.106": version "4.14.106" resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.106.tgz#6093e9a02aa567ddecfe9afadca89e53e5dce4dd" From 6f8dee402d8a4450069a2a4c9f79f2eee15d12ff Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Mon, 9 Apr 2018 20:01:38 -0400 Subject: [PATCH 04/24] Add `@types/mocha` --- package.json | 1 + yarn.lock | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/package.json b/package.json index fa0567c99..90bd14280 100644 --- a/package.json +++ b/package.json @@ -94,6 +94,7 @@ "devDependencies": { "@types/chai": "^4.1.2", "@types/lodash": "^4.14.106", + "@types/mocha": "^5.0.0", "@types/qs": "^6.5.1", "@types/react": "^16.3.1", "@types/react-dom": "^16.0.4", diff --git a/yarn.lock b/yarn.lock index 40be0bbc4..fa589545c 100644 --- a/yarn.lock +++ b/yarn.lock @@ -44,6 +44,10 @@ version "4.14.106" resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.106.tgz#6093e9a02aa567ddecfe9afadca89e53e5dce4dd" +"@types/mocha@^5.0.0": + version "5.0.0" + resolved "https://registry.yarnpkg.com/@types/mocha/-/mocha-5.0.0.tgz#a3014921991066193f6c8e47290d4d598dfd19e6" + "@types/node@*": version "9.6.1" resolved "https://registry.yarnpkg.com/@types/node/-/node-9.6.1.tgz#e2d374ef15b315b48e7efc308fa1a7cd51faa06c" From f38370f40e40e7f2df030bdc29a87b8d41ab33d4 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 10 Apr 2018 12:58:31 -0400 Subject: [PATCH 05/24] Add custom type definition for `link-text` --- ts/@types/link-text/index.d.ts | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 ts/@types/link-text/index.d.ts diff --git a/ts/@types/link-text/index.d.ts b/ts/@types/link-text/index.d.ts new file mode 100644 index 000000000..9663edce6 --- /dev/null +++ b/ts/@types/link-text/index.d.ts @@ -0,0 +1,6 @@ +declare module 'link-text' { + type Attributes = { + [key: string]: string; + } + export default function (value: string, attributes: Attributes): string +} From 7d4ef9315bd9da6ddb0881dd0f248997e089683c Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 10 Apr 2018 13:04:03 -0400 Subject: [PATCH 06/24] Add `yarn test-ts` --- package.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 90bd14280..09d77be05 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "main": "main.js", "scripts": { "postinstall": "electron-builder install-app-deps && rimraf node_modules/dtrace-provider", - "test": "yarn eslint && yarn tslint && yarn test-server && grunt test && yarn test-app && yarn test-modules", + "test": "yarn eslint && yarn tslint && yarn test-server && grunt test && yarn test-app && yarn test-modules && yarn test-ts", "lint": "grunt jshint", "start": "electron .", "asarl": "asar l release/mac/Signal.app/Contents/Resources/app.asar", @@ -38,6 +38,7 @@ "release": "npm run release-mac && npm run release-win && npm run release-lin", "test-app": "mocha --recursive test/app", "test-modules": "mocha --recursive test/modules", + "test-ts": "mocha --recursive ts/test-unit", "test-server": "mocha --recursive test/server", "test-server-coverage": "nyc --reporter=lcov --reporter=text mocha --recursive test/server", "eslint": "eslint .", From 144cb58a4774a789e9b6ca2ec80b15f6dbd170d0 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 10 Apr 2018 13:03:05 -0400 Subject: [PATCH 07/24] Add `HTML` module for rendering messages --- ts/html/index.ts | 12 +++++ ts/test-unit/html/index_test.ts | 96 +++++++++++++++++++++++++++++++++ 2 files changed, 108 insertions(+) create mode 100644 ts/html/index.ts create mode 100644 ts/test-unit/html/index_test.ts diff --git a/ts/html/index.ts b/ts/html/index.ts new file mode 100644 index 000000000..b3c6ae211 --- /dev/null +++ b/ts/html/index.ts @@ -0,0 +1,12 @@ +import linkTextInternal from 'link-text'; + + +export const linkText = (value: string): string => + linkTextInternal(value, { target: '_blank' }); + +export const replaceLineBreaks = (value: string): string => + value.replace(/\r?\n/g, '
'); + +// NOTE: How can we use `lodash/fp` `compose` with type checking? +export const render = (value: string): string => + replaceLineBreaks(linkText(value)); diff --git a/ts/test-unit/html/index_test.ts b/ts/test-unit/html/index_test.ts new file mode 100644 index 000000000..f70912b78 --- /dev/null +++ b/ts/test-unit/html/index_test.ts @@ -0,0 +1,96 @@ +import 'mocha'; +import { assert } from 'chai'; + +import * as HTML from '../../html'; + +interface Test { + input: string; + name: string; + output?: string; + outputHref?: string; + outputLabel?: string; + postText?: string; + preText?: string; + skipped?: boolean; +} + +describe('HTML', () => { + describe('linkText', () => { + const TESTS: Array = [ + { + name: 'square brackets', + input: 'https://www.example.com/test.html?foo=bar&baz[qux]=quux', + output: 'https://www.example.com/test.html?foo=bar&baz[qux]=quux', + }, + { + name: 'Chinese characters', + input: 'https://zh.wikipedia.org/zh-hans/信号', + output: 'https://zh.wikipedia.org/zh-hans/信号', + }, + { + name: 'Cyrillic characters', + input: 'https://ru.wikipedia.org/wiki/Сигнал', + output: 'https://ru.wikipedia.org/wiki/Сигнал', + }, + { + skipped: true, + name: 'trailing exclamation points', + input: 'https://en.wikipedia.org/wiki/Mother!', + output: 'https://en.wikipedia.org/wiki/Mother!', + }, + { + name: 'single quotes', + input: "https://www.example.com/this-couldn't-be-true", + output: "https://www.example.com/this-couldn#39;t-be-true", + }, + { + name: 'special characters before URL begins', + preText: 'wink ;)', + input: 'https://www.youtube.com/watch?v=oHg5SJYRHA0', + output: 'https://www.youtube.com/watch?v=oHg5SJYRHA0', + }, + { + name: 'URLs without protocols', + input: 'github.com', + outputHref: 'http://github.com', + outputLabel: 'github.com', + }, + ]; + + TESTS.forEach((test) => { + (test.skipped ? it.skip : it)(`should handle ${test.name}`, () => { + const preText = test.preText || 'Hello '; + const postText = test.postText || ' World!'; + const input: string = `${preText}${test.input}${postText}`; + const expected: string = [ + preText, + ``, + test.outputLabel || test.output, + '', + postText, + ].join(''); + + const actual = HTML.linkText(input); + assert.equal(actual, expected); + }); + }); + }); + + describe('render', () => { + it('should preserve line breaks', () => { + const input: string = 'Hello\n\n\nWorld!'; + const expected: string = 'Hello


World!'; + + const actual = HTML.render(input); + assert.equal(actual, expected); + }); + + it('should escape HTML', () => { + const input: string = "Hello\nWorld!"; + const expected: string = 'Hello
<script>alert('evil');</script>World!'; + + const actual = HTML.render(input); + assert.equal(actual, expected); + }); + }); +}); From ac50713f869e8a047bed2e34b3c97f53fba093a5 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 10 Apr 2018 13:03:50 -0400 Subject: [PATCH 08/24] Improve auto-linking of URLs in messages Fixes #598. --- js/views/message_view.js | 5 +++-- preload.js | 1 + 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/js/views/message_view.js b/js/views/message_view.js index 866cba27a..59f0e54d8 100644 --- a/js/views/message_view.js +++ b/js/views/message_view.js @@ -6,6 +6,7 @@ 'use strict'; window.Whisper = window.Whisper || {}; + const { HTML } = window.Signal; const { Attachment } = window.Signal.Types; const { loadAttachmentData } = window.Signal.Migrations; @@ -375,8 +376,8 @@ emoji_util.parse(body); if (body.length > 0) { - var escaped = body.html(); - body.html(escaped.replace(/\n/g, '
').replace(URL_REGEX, "$1$2")); + const escapedBody = body.html(); + body.html(HTML.render(escapedBody)); } this.renderSent(); diff --git a/preload.js b/preload.js index d11951f73..9146f6216 100644 --- a/preload.js +++ b/preload.js @@ -158,6 +158,7 @@ window.Signal.Backup = require('./js/modules/backup'); window.Signal.Crypto = require('./js/modules/crypto'); window.Signal.Database = require('./js/modules/database'); window.Signal.Debug = require('./js/modules/debug'); +window.Signal.HTML = require('./ts/html'); window.Signal.Logs = require('./js/modules/logs'); window.Signal.Components = {}; From d9381c543ec0419ff8a224281666ab583311c068 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 10 Apr 2018 15:00:09 -0400 Subject: [PATCH 09/24] Add `linkify-it` dependency --- package.json | 1 + yarn.lock | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/package.json b/package.json index 09d77be05..e7819c8b8 100644 --- a/package.json +++ b/package.json @@ -73,6 +73,7 @@ "google-libphonenumber": "^3.0.7", "got": "^8.2.0", "link-text": "^0.0.1", + "linkify-it": "^2.0.3", "lodash": "^4.17.4", "mkdirp": "^0.5.1", "moment": "^2.21.0", diff --git a/yarn.lock b/yarn.lock index fa589545c..44fddf2c8 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5176,6 +5176,12 @@ linkify-it@^1.2.0: dependencies: uc.micro "^1.0.1" +linkify-it@^2.0.3: + version "2.0.3" + resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-2.0.3.tgz#d94a4648f9b1c179d64fa97291268bdb6ce9434f" + dependencies: + uc.micro "^1.0.1" + listify@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/listify/-/listify-1.0.0.tgz#03ca7ba2d150d4267773f74e57558d1053d2bee3" From f04c65088bd61355a14eee96ccd323e61e39ee37 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 10 Apr 2018 13:33:46 -0400 Subject: [PATCH 10/24] Fork `link-text` module --- js/modules/link_text.d.ts | 9 +++++++ js/modules/link_text.js | 47 ++++++++++++++++++++++++++++++++++ ts/@types/link-text/index.d.ts | 6 ----- ts/html/index.ts | 2 +- 4 files changed, 57 insertions(+), 7 deletions(-) create mode 100644 js/modules/link_text.d.ts create mode 100644 js/modules/link_text.js delete mode 100644 ts/@types/link-text/index.d.ts diff --git a/js/modules/link_text.d.ts b/js/modules/link_text.d.ts new file mode 100644 index 000000000..72e015249 --- /dev/null +++ b/js/modules/link_text.d.ts @@ -0,0 +1,9 @@ +declare namespace LinkText { + type Attributes = { + [key: string]: string; + } +} + +declare function linkText(value: string, attributes: LinkText.Attributes): string; + +export = linkText; diff --git a/js/modules/link_text.js b/js/modules/link_text.js new file mode 100644 index 000000000..b1be65dc1 --- /dev/null +++ b/js/modules/link_text.js @@ -0,0 +1,47 @@ +// Fork of https://github.com/uiureo/link-text with HTML escaping disabled as we leverage +// jQuery’s escaping mechanism: + +var linkify = require('linkify-it')() +var escape = require('escape-html') + +function createLink (url, text, attrs) { + attrs = attrs || {} + + var html = [] + html.push('') + html.push(decodeURIComponent(text)) + html.push('') + + return html.join('') +} + +module.exports = function (text, attrs) { + attrs = attrs || {} + text = escape(text) + + var matchData = linkify.match(text) || [] + + var result = [] + var last = 0 + + matchData.forEach(function (match) { + if (last < match.index) { + result.push(text.slice(last, match.index)) + } + + result.push( + createLink(match.url, match.text, attrs) + ) + + last = match.lastIndex + }) + + result.push(text.slice(last)) + + return result.join('') +} diff --git a/ts/@types/link-text/index.d.ts b/ts/@types/link-text/index.d.ts deleted file mode 100644 index 9663edce6..000000000 --- a/ts/@types/link-text/index.d.ts +++ /dev/null @@ -1,6 +0,0 @@ -declare module 'link-text' { - type Attributes = { - [key: string]: string; - } - export default function (value: string, attributes: Attributes): string -} diff --git a/ts/html/index.ts b/ts/html/index.ts index b3c6ae211..3aad63218 100644 --- a/ts/html/index.ts +++ b/ts/html/index.ts @@ -1,4 +1,4 @@ -import linkTextInternal from 'link-text'; +import linkTextInternal from '../../js/modules/link_text'; export const linkText = (value: string): string => From 9d41b8616296f1b328aa864e0114b99d7f11ca06 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 10 Apr 2018 14:57:09 -0400 Subject: [PATCH 11/24] Remove escaping from `linkText` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit We leverage jQuery’s HTML escaping in `$.html(…)`. --- js/modules/link_text.js | 2 -- package.json | 1 - ts/test-unit/html/index_test.ts | 8 ++++---- yarn.lock | 15 +-------------- 4 files changed, 5 insertions(+), 21 deletions(-) diff --git a/js/modules/link_text.js b/js/modules/link_text.js index b1be65dc1..610d1f104 100644 --- a/js/modules/link_text.js +++ b/js/modules/link_text.js @@ -2,7 +2,6 @@ // jQuery’s escaping mechanism: var linkify = require('linkify-it')() -var escape = require('escape-html') function createLink (url, text, attrs) { attrs = attrs || {} @@ -22,7 +21,6 @@ function createLink (url, text, attrs) { module.exports = function (text, attrs) { attrs = attrs || {} - text = escape(text) var matchData = linkify.match(text) || [] diff --git a/package.json b/package.json index e7819c8b8..5dad36fa8 100644 --- a/package.json +++ b/package.json @@ -72,7 +72,6 @@ "fs-extra": "^5.0.0", "google-libphonenumber": "^3.0.7", "got": "^8.2.0", - "link-text": "^0.0.1", "linkify-it": "^2.0.3", "lodash": "^4.17.4", "mkdirp": "^0.5.1", diff --git a/ts/test-unit/html/index_test.ts b/ts/test-unit/html/index_test.ts index f70912b78..f2c4602a5 100644 --- a/ts/test-unit/html/index_test.ts +++ b/ts/test-unit/html/index_test.ts @@ -20,7 +20,7 @@ describe('HTML', () => { { name: 'square brackets', input: 'https://www.example.com/test.html?foo=bar&baz[qux]=quux', - output: 'https://www.example.com/test.html?foo=bar&baz[qux]=quux', + output: 'https://www.example.com/test.html?foo=bar&baz[qux]=quux', }, { name: 'Chinese characters', @@ -41,7 +41,7 @@ describe('HTML', () => { { name: 'single quotes', input: "https://www.example.com/this-couldn't-be-true", - output: "https://www.example.com/this-couldn#39;t-be-true", + output: "https://www.example.com/this-couldn't-be-true", }, { name: 'special characters before URL begins', @@ -85,9 +85,9 @@ describe('HTML', () => { assert.equal(actual, expected); }); - it('should escape HTML', () => { + it('should not escape HTML', () => { const input: string = "Hello\nWorld!"; - const expected: string = 'Hello
<script>alert('evil');</script>World!'; + const expected: string = "Hello
World!"; const actual = HTML.render(input); assert.equal(actual, expected); diff --git a/yarn.lock b/yarn.lock index 44fddf2c8..d957d4cf9 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2745,7 +2745,7 @@ es6-promisify@^5.0.0: dependencies: es6-promise "^4.0.3" -escape-html@^1.0.3, escape-html@~1.0.3: +escape-html@~1.0.3: version "1.0.3" resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988" @@ -5163,19 +5163,6 @@ lie@*: dependencies: immediate "~3.0.5" -link-text@^0.0.1: - version "0.0.1" - resolved "https://registry.yarnpkg.com/link-text/-/link-text-0.0.1.tgz#d185042f4ec3eda07af7aeb773ab7f7cbd18adc2" - dependencies: - escape-html "^1.0.3" - linkify-it "^1.2.0" - -linkify-it@^1.2.0: - version "1.2.4" - resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-1.2.4.tgz#0773526c317c8fd13bd534ee1d180ff88abf881a" - dependencies: - uc.micro "^1.0.1" - linkify-it@^2.0.3: version "2.0.3" resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-2.0.3.tgz#d94a4648f9b1c179d64fa97291268bdb6ce9434f" From d7b845326db1aff4dd7e0609b1b2cb6dcd8bf59b Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 10 Apr 2018 15:00:55 -0400 Subject: [PATCH 12/24] ESLint auto-fix `link_text` --- js/modules/link_text.js | 58 ++++++++++++++++++----------------------- 1 file changed, 26 insertions(+), 32 deletions(-) diff --git a/js/modules/link_text.js b/js/modules/link_text.js index 610d1f104..5354f3da8 100644 --- a/js/modules/link_text.js +++ b/js/modules/link_text.js @@ -1,45 +1,39 @@ // Fork of https://github.com/uiureo/link-text with HTML escaping disabled as we leverage // jQuery’s escaping mechanism: -var linkify = require('linkify-it')() - -function createLink (url, text, attrs) { - attrs = attrs || {} - - var html = [] - html.push('') - html.push(decodeURIComponent(text)) - html.push('') - - return html.join('') +const linkify = require('linkify-it')(); + +function createLink(url, text, attrs = {}) { + const html = []; + html.push(' { + html.push(` ${key}="${attrs[key]}"`); + }); + html.push('>'); + html.push(decodeURIComponent(text)); + html.push(''); + + return html.join(''); } -module.exports = function (text, attrs) { - attrs = attrs || {} +module.exports = (text, attrs = {}) => { + const matchData = linkify.match(text) || []; - var matchData = linkify.match(text) || [] + const result = []; + let last = 0; - var result = [] - var last = 0 - - matchData.forEach(function (match) { + matchData.forEach((match) => { if (last < match.index) { - result.push(text.slice(last, match.index)) + result.push(text.slice(last, match.index)); } - result.push( - createLink(match.url, match.text, attrs) - ) + result.push(createLink(match.url, match.text, attrs)); - last = match.lastIndex - }) + last = match.lastIndex; + }); - result.push(text.slice(last)) + result.push(text.slice(last)); - return result.join('') -} + return result.join(''); +}; From b8bbed3ec9da2591b26f34b1587966eff69fd141 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 10 Apr 2018 15:33:01 -0400 Subject: [PATCH 13/24] Compile and lint TypeScript on AppVeyor --- appveyor.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/appveyor.yml b/appveyor.yml index 12b986e7a..6e8422b39 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -12,8 +12,10 @@ install: - yarn install --frozen-lockfile build_script: + - yarn transpile - yarn nsp check - yarn eslint + - yarn tslint - yarn test-server - yarn lint - yarn run icon-gen From d6b40a3e9480c55d7e0e5d2420f59cdc3a2ec903 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 10 Apr 2018 16:24:16 -0400 Subject: [PATCH 14/24] Explicitly point to TSLint configuration AppVeyor seems to ignore our configuration. --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 5dad36fa8..0c962ba8f 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "test-server": "mocha --recursive test/server", "test-server-coverage": "nyc --reporter=lcov --reporter=text mocha --recursive test/server", "eslint": "eslint .", - "tslint": "tslint ts/**/*.{ts,tsx}", + "tslint": "tslint --config tslint.json ts/**/*.{ts,tsx}", "transpile": "tsc", "clean-transpile": "rimraf ts/**/*.js ts/*.js", "open-coverage": "open coverage/lcov-report/index.html", From 80de7bbd5cfb071c209a3236a909b1597c2f45e3 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 10 Apr 2018 16:24:30 -0400 Subject: [PATCH 15/24] Compile TypeScript files on Travis CI --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index 5799ff32d..78cc1bc43 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,6 +7,7 @@ dist: trusty install: - yarn install --frozen-lockfile script: + - yarn transpile - yarn nsp check - yarn run generate - yarn prepare-beta-build From 15d221ae0ebe7e51dca0df9be7a9260492977d51 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Tue, 10 Apr 2018 17:47:25 -0400 Subject: [PATCH 16/24] Simplify testing and linting Separate linting from testing as follows: - `yarn jscs`: Run JSCS. - `yarn jshint`: Run JSHint. - `yarn lint`: Run all linters, i.e. ESLint, TSLint, JSHint, and JSHint. - `yarn test-node`: Run Mocha tests in Node.js environment. - `yarn test-electron`: Run tests in Electron environment via Grunt. - `yarn test`: Run all tests. CI - Align Travis and AppVeyor scripts as much as possible. - Run linting before tests to fail fast. - Run Node.js (headless and fast) tests first. - Run Electron tests last (Travis seems to require custom setup in `travis.sh`). --- .travis.yml | 7 +++---- Gruntfile.js | 3 ++- appveyor.yml | 7 ++----- package.json | 16 ++++++++-------- test/{server => }/app/logging_test.js | 2 +- travis.sh | 4 ++-- 6 files changed, 18 insertions(+), 21 deletions(-) rename test/{server => }/app/logging_test.js (99%) diff --git a/.travis.yml b/.travis.yml index 78cc1bc43..52521d16a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -8,12 +8,11 @@ install: - yarn install --frozen-lockfile script: - yarn transpile + - yarn lint - yarn nsp check - - yarn run generate + - yarn generate - yarn prepare-beta-build - - yarn eslint - - yarn test-server - - yarn lint + - yarn test-node - $(yarn bin)/build --config.extraMetadata.environment=$SIGNAL_ENV --config.mac.bundleVersion='$TRAVIS_BUILD_NUMBER' --publish=never - ./travis.sh env: diff --git a/Gruntfile.js b/Gruntfile.js index 46abd1ec2..ab96bbf69 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -480,7 +480,8 @@ module.exports = function(grunt) { grunt.registerTask('tx', ['exec:tx-pull', 'locale-patch']); grunt.registerTask('dev', ['default', 'watch']); - grunt.registerTask('test', ['jshint', 'jscs', 'unit-tests', 'lib-unit-tests']); + grunt.registerTask('lint', ['jshint', 'jscs']); + grunt.registerTask('test', ['unit-tests', 'lib-unit-tests']); grunt.registerTask('copy_dist', ['gitinfo', 'copy:res', 'copy:src']); grunt.registerTask('date', ['gitinfo', 'getExpireTime']); grunt.registerTask('prep-release', ['gitinfo', 'clean-release', 'fetch-release']); diff --git a/appveyor.yml b/appveyor.yml index 6e8422b39..b434efc8b 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -13,12 +13,9 @@ install: build_script: - yarn transpile - - yarn nsp check - - yarn eslint - - yarn tslint - - yarn test-server - yarn lint - - yarn run icon-gen + - yarn nsp check + - yarn generate - node build\grunt.js - type package.json | findstr /v certificateSubjectName > temp.json - move temp.json package.json diff --git a/package.json b/package.json index 0c962ba8f..b45cc4fc3 100644 --- a/package.json +++ b/package.json @@ -12,8 +12,6 @@ "main": "main.js", "scripts": { "postinstall": "electron-builder install-app-deps && rimraf node_modules/dtrace-provider", - "test": "yarn eslint && yarn tslint && yarn test-server && grunt test && yarn test-app && yarn test-modules && yarn test-ts", - "lint": "grunt jshint", "start": "electron .", "asarl": "asar l release/mac/Signal.app/Contents/Resources/app.asar", "icon-gen": "electron-icon-maker --input=images/icon_1024.png --output=./build", @@ -36,13 +34,15 @@ "release-win": "npm run build-release -- -w --prepackaged release/windows --publish=always", "release-lin": "npm run build-release -- -l --prepackaged release/linux && NAME=$npm_package_name VERSION=$npm_package_version ./aptly.sh", "release": "npm run release-mac && npm run release-win && npm run release-lin", - "test-app": "mocha --recursive test/app", - "test-modules": "mocha --recursive test/modules", - "test-ts": "mocha --recursive ts/test-unit", - "test-server": "mocha --recursive test/server", - "test-server-coverage": "nyc --reporter=lcov --reporter=text mocha --recursive test/server", + "test-node": "mocha --recursive test/app test/modules ts/test-unit", + "test-electron": "yarn grunt test", + "test-electron-coverage": "nyc --reporter=lcov --reporter=text mocha --recursive test/app test/modules ts/test-unit", + "test": "yarn test-node && yarn test-electron", + "jscs": "yarn grunt jscs", + "jshint": "yarn grunt jshint", "eslint": "eslint .", - "tslint": "tslint --config tslint.json ts/**/*.{ts,tsx}", + "tslint": "tslint ts/**/*.{ts,tsx}", + "lint": "yarn eslint && yarn tslint && yarn jshint && yarn jscs", "transpile": "tsc", "clean-transpile": "rimraf ts/**/*.js ts/*.js", "open-coverage": "open coverage/lcov-report/index.html", diff --git a/test/server/app/logging_test.js b/test/app/logging_test.js similarity index 99% rename from test/server/app/logging_test.js rename to test/app/logging_test.js index 04f73e1d1..3cd1383ce 100644 --- a/test/server/app/logging_test.js +++ b/test/app/logging_test.js @@ -13,7 +13,7 @@ const { isLineAfterDate, fetchLog, fetch, -} = require('../../../app/logging'); +} = require('../../app/logging'); describe('app/logging', () => { let basePath; diff --git a/travis.sh b/travis.sh index 590d40288..8515d5851 100755 --- a/travis.sh +++ b/travis.sh @@ -8,6 +8,6 @@ if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sleep 3 fi -grunt test +yarn test-electron -NODE_ENV=production grunt test-release:$TRAVIS_OS_NAME +NODE_ENV=production yarn grunt test-release:$TRAVIS_OS_NAME From e052d1df7b01923394f8f68f6546f0bb1b127ce0 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Mon, 9 Apr 2018 19:13:39 -0400 Subject: [PATCH 17/24] Use generic array syntax for consistency Always prefer `Array` over `T[]` for primitive types only. --- tslint.json | 1 + 1 file changed, 1 insertion(+) diff --git a/tslint.json b/tslint.json index a8a569505..72eee0973 100644 --- a/tslint.json +++ b/tslint.json @@ -6,6 +6,7 @@ ], "jsRules": {}, "rules": { + "array-type": [true, "generic"], "quotemark": [true, "single", "jsx-double", "avoid-template", "avoid-escape"], "no-consecutive-blank-lines": [true, 2], "interface-name": [true, "never-prefix"] From 6f4d0e14494536a6e0481766edcdc7f0b930ecc7 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Wed, 11 Apr 2018 11:02:34 -0400 Subject: [PATCH 18/24] Use project for TSLint --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index b45cc4fc3..5ae98a286 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,7 @@ "jscs": "yarn grunt jscs", "jshint": "yarn grunt jshint", "eslint": "eslint .", - "tslint": "tslint ts/**/*.{ts,tsx}", + "tslint": "tslint --config tslint.json --project . --format stylish", "lint": "yarn eslint && yarn tslint && yarn jshint && yarn jscs", "transpile": "tsc", "clean-transpile": "rimraf ts/**/*.js ts/*.js", From 7cb43c9f7f9652162feb98e7804a1eef8897d519 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Wed, 11 Apr 2018 11:02:42 -0400 Subject: [PATCH 19/24] Add TSLint rules --- tslint.json | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/tslint.json b/tslint.json index 72eee0973..060e9c463 100644 --- a/tslint.json +++ b/tslint.json @@ -7,9 +7,20 @@ "jsRules": {}, "rules": { "array-type": [true, "generic"], - "quotemark": [true, "single", "jsx-double", "avoid-template", "avoid-escape"], + "interface-name": [true, "never-prefix"], "no-consecutive-blank-lines": [true, 2], - "interface-name": [true, "never-prefix"] + "object-literal-key-quotes": [true, "as-needed"], + "object-literal-sort-keys": false, + + // Ignore import sources order until we can specify that we want ordering + // based on import name vs module name: + "ordered-imports": [true, { + "import-sources-order": "any", + "named-imports-order": "case-insensitive" + }], + + "quotemark": [true, "single", "jsx-double", "avoid-template", "avoid-escape"] + }, "rulesDirectory": [] } From 513d9a5d5c64db73cc5f6737c151aa306a7386cd Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Wed, 11 Apr 2018 12:15:19 -0400 Subject: [PATCH 20/24] Run Node.js tests early --- .travis.yml | 2 +- appveyor.yml | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 52521d16a..00914fb16 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,10 +9,10 @@ install: script: - yarn transpile - yarn lint + - yarn test-node - yarn nsp check - yarn generate - yarn prepare-beta-build - - yarn test-node - $(yarn bin)/build --config.extraMetadata.environment=$SIGNAL_ENV --config.mac.bundleVersion='$TRAVIS_BUILD_NUMBER' --publish=never - ./travis.sh env: diff --git a/appveyor.yml b/appveyor.yml index b434efc8b..43b0df1b8 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -14,6 +14,7 @@ install: build_script: - yarn transpile - yarn lint + - yarn test-node - yarn nsp check - yarn generate - node build\grunt.js From d6436de3bda3e253b7968a7e098a80f21d16debb Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Wed, 11 Apr 2018 14:57:15 -0400 Subject: [PATCH 21/24] Organize npm scripts Combine `yarn grunt jshint` and `yarn grunt jscs` into `yarn grunt lint`. --- package.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 5ae98a286..3c2520e41 100644 --- a/package.json +++ b/package.json @@ -34,15 +34,15 @@ "release-win": "npm run build-release -- -w --prepackaged release/windows --publish=always", "release-lin": "npm run build-release -- -l --prepackaged release/linux && NAME=$npm_package_name VERSION=$npm_package_version ./aptly.sh", "release": "npm run release-mac && npm run release-win && npm run release-lin", - "test-node": "mocha --recursive test/app test/modules ts/test-unit", - "test-electron": "yarn grunt test", - "test-electron-coverage": "nyc --reporter=lcov --reporter=text mocha --recursive test/app test/modules ts/test-unit", "test": "yarn test-node && yarn test-electron", + "test-electron": "yarn grunt test", + "test-node": "mocha --recursive test/app test/modules ts/test-unit", + "test-node-coverage": "nyc --reporter=lcov --reporter=text mocha --recursive test/app test/modules ts/test-unit", + "eslint": "eslint .", "jscs": "yarn grunt jscs", "jshint": "yarn grunt jshint", - "eslint": "eslint .", + "lint": "yarn eslint && yarn grunt lint && yarn tslint", "tslint": "tslint --config tslint.json --project . --format stylish", - "lint": "yarn eslint && yarn tslint && yarn jshint && yarn jscs", "transpile": "tsc", "clean-transpile": "rimraf ts/**/*.js ts/*.js", "open-coverage": "open coverage/lcov-report/index.html", From 99dbdc3506e37e96d4c0f542031c980163fb5378 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Wed, 11 Apr 2018 15:10:57 -0400 Subject: [PATCH 22/24] Include compiled TypeScript JavaScript files in build --- package.json | 2 ++ 1 file changed, 2 insertions(+) diff --git a/package.json b/package.json index 3c2520e41..7230f008c 100644 --- a/package.json +++ b/package.json @@ -228,6 +228,8 @@ "_locales/**", "protos/*", "js/**", + "ts/**/*.js", + "ts/*.js", "stylesheets/*.css", "!js/register.js", "!js/views/standalone_registration_view.js", From 96c07c6373dd3657c9c6bd3e34771a97f18727c1 Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Wed, 11 Apr 2018 15:13:43 -0400 Subject: [PATCH 23/24] Bump timeout of `debuglogs` test --- test/modules/debuglogs_test.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/modules/debuglogs_test.js b/test/modules/debuglogs_test.js index 3a6e45e90..8d5552240 100644 --- a/test/modules/debuglogs_test.js +++ b/test/modules/debuglogs_test.js @@ -12,6 +12,6 @@ describe('debuglogs', () => { const { body } = await got.get(url); assert.equal(nonce, body); - }); + }).timeout(3000); }); }); From 55fc21505ec5575d74ded3a77ecc476e8c5e7aaa Mon Sep 17 00:00:00 2001 From: Daniel Gasienica Date: Wed, 11 Apr 2018 16:31:35 -0400 Subject: [PATCH 24/24] Rename `ts/test` to `ts/styleguide` --- package.json | 4 ++-- preload.js | 2 +- styleguide.config.js | 4 ++-- ts/{test => styleguide}/ConversationContext.md | 0 ts/{test => styleguide}/ConversationContext.tsx | 0 ts/{test => styleguide}/StyleGuideUtil.ts | 0 ts/{test-unit => test}/html/index_test.ts | 0 7 files changed, 5 insertions(+), 5 deletions(-) rename ts/{test => styleguide}/ConversationContext.md (100%) rename ts/{test => styleguide}/ConversationContext.tsx (100%) rename ts/{test => styleguide}/StyleGuideUtil.ts (100%) rename ts/{test-unit => test}/html/index_test.ts (100%) diff --git a/package.json b/package.json index 7230f008c..967fd0171 100644 --- a/package.json +++ b/package.json @@ -36,8 +36,8 @@ "release": "npm run release-mac && npm run release-win && npm run release-lin", "test": "yarn test-node && yarn test-electron", "test-electron": "yarn grunt test", - "test-node": "mocha --recursive test/app test/modules ts/test-unit", - "test-node-coverage": "nyc --reporter=lcov --reporter=text mocha --recursive test/app test/modules ts/test-unit", + "test-node": "mocha --recursive test/app test/modules ts/test", + "test-node-coverage": "nyc --reporter=lcov --reporter=text mocha --recursive test/app test/modules ts/test", "eslint": "eslint .", "jscs": "yarn grunt jscs", "jshint": "yarn grunt jshint", diff --git a/preload.js b/preload.js index 9146f6216..aca6cbabc 100644 --- a/preload.js +++ b/preload.js @@ -114,7 +114,7 @@ window.ProxyAgent = require('proxy-agent'); // two locations: // // 1) test/styleguide/legacy_bridge.js -// 2) ts/test/StyleGuideUtil.js +// 2) ts/styleguide/StyleGuideUtil.js window.React = require('react'); window.ReactDOM = require('react-dom'); diff --git a/styleguide.config.js b/styleguide.config.js index c832513de..69a8b8612 100644 --- a/styleguide.config.js +++ b/styleguide.config.js @@ -20,12 +20,12 @@ module.exports = { { name: 'Test', description: 'Components only used for testing', - components: 'ts/test/**/*.tsx', + components: 'ts/styleguide/**/*.tsx', }, ], context: { // Exposes necessary utilities in the global scope for all readme code snippets - util: 'ts/test/StyleGuideUtil', + util: 'ts/styleguide/StyleGuideUtil', }, // We don't want one long, single page pagePerSection: true, diff --git a/ts/test/ConversationContext.md b/ts/styleguide/ConversationContext.md similarity index 100% rename from ts/test/ConversationContext.md rename to ts/styleguide/ConversationContext.md diff --git a/ts/test/ConversationContext.tsx b/ts/styleguide/ConversationContext.tsx similarity index 100% rename from ts/test/ConversationContext.tsx rename to ts/styleguide/ConversationContext.tsx diff --git a/ts/test/StyleGuideUtil.ts b/ts/styleguide/StyleGuideUtil.ts similarity index 100% rename from ts/test/StyleGuideUtil.ts rename to ts/styleguide/StyleGuideUtil.ts diff --git a/ts/test-unit/html/index_test.ts b/ts/test/html/index_test.ts similarity index 100% rename from ts/test-unit/html/index_test.ts rename to ts/test/html/index_test.ts