Skip to content

Commit 5c28ac5

Browse files
chrisbobbechrisbobbe
committed
tools: Add check-messages-en, to find dangling messages in messages_en.json
As discussed on CZO: https://chat.zulip.org/#narrow/stream/243-mobile-team/topic/Strings.20in.20messages_en.2Ejson.20but.20not.20in.20the.20app/near/1425641 Run with: tools/check-messages-en This gives just one result, which we'll address next. We add flow-parser at <0.159.0. We'd like a later version -- probably ideal would be to sync it with flow-bin, which is ^0.170.0 right now -- but facebook/flow@5de4ea57e, released in v0.159.0, was a change that isn't yet handled by any version of ast-types [1]. A fix for ast-types is open as the issue benjamn/ast-types#728 and PR benjamn/ast-types#727. [1] I get this error output: /Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/types.js:669 throw new Error("did not recognize object of type " + ^ Error: did not recognize object of type "PropertyDefinition" at Object.getFieldNames (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/types.js:669:19) at visitChildren (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:185:36) at Visitor.PVp.visitWithoutReset (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:167:20) at NodePath.each (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path.js:88:26) at visitChildren (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:179:18) at Visitor.PVp.visitWithoutReset (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:167:20) at visitChildren (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:204:25) at Visitor.PVp.visitWithoutReset (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:167:20) at visitChildren (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:204:25) at Visitor.PVp.visitWithoutReset (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:167:20)
1 parent 5db0e02 commit 5c28ac5

File tree

3 files changed

+259
-4
lines changed

3 files changed

+259
-4
lines changed

‎package.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@
9393
"@rollup/plugin-node-resolve": "^13.0.4",
9494
"@types/react-native": "~0.67.6",
9595
"@vusion/webfonts-generator": "^0.8.0",
96+
"ast-types": "^0.16.1",
9697
"babel-plugin-transform-flow-enums": "^0.0.2",
9798
"core-js": "^3.1.4",
9899
"deep-freeze": "^0.0.1",
@@ -108,6 +109,7 @@
108109
"eslint-plugin-react-hooks": "^4.5.0",
109110
"flow-bin": "^0.170.0",
110111
"flow-coverage-report": "^0.8.0",
112+
"flow-parser": "<0.159.0",
111113
"flow-typed": "^3.3.1",
112114
"hermes-eslint": "^0.9.0",
113115
"immutable-devtools": "^0.1.5",
@@ -126,6 +128,7 @@
126128
"prettier-eslint-cli": "^6.0.1",
127129
"react-native-cli": "^2.0.1",
128130
"react-test-renderer": "17.0.2",
131+
"recast": "^0.22.0",
129132
"redux-mock-store": "^1.5.1",
130133
"rollup": "^2.26.5",
131134
"sqlite3": "^5.0.2",

‎tools/check-messages-en‎

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
#!/usr/bin/env node
2+
3+
// TODO: Type-check this file
4+
5+
// Sadly our auto-format doesn't seem to run eslint on this file; give in to
6+
// Prettier here.
7+
// TODO: debug
8+
/* eslint-disable operator-linebreak */
9+
10+
const fs = require('fs');
11+
const path = require('path');
12+
const { namedTypes: n, visit } = require('ast-types');
13+
const flowParser = require('flow-parser');
14+
const { parse } = require('recast');
15+
16+
const messages_en = require('../static/translations/messages_en.json');
17+
18+
/**
19+
* Make a list of files that might contain UI strings, by recursing in src/.
20+
*/
21+
function getPossibleUiStringFilePaths() {
22+
const result = [];
23+
const kSrcDirName = 'src/';
24+
function walk(dir, _dirName = '') {
25+
let dirent;
26+
// eslint-disable-next-line no-cond-assign
27+
while ((dirent = dir.readSync())) {
28+
// To reduce false negatives, `continue` when nothing in `dirent` can
29+
// cause UI strings to appear in the app.
30+
31+
if (dirent.isFile()) {
32+
if (!dirent.name.endsWith('.js')) {
33+
// Non-JS code, and Flow type definitions in .js.flow files.
34+
continue;
35+
}
36+
37+
result.push(path.join(kSrcDirName, _dirName, dirent.name));
38+
} else if (dirent.isDirectory()) {
39+
const subdirName = path.join(_dirName, dirent.name);
40+
41+
// e.g., …/__tests__ and …/__flow-tests__
42+
if (subdirName.endsWith('tests__')) {
43+
// Test code.
44+
continue;
45+
}
46+
47+
walk(fs.opendirSync(path.join(kSrcDirName, subdirName)), subdirName);
48+
} else {
49+
// Something we don't expect to find under src/, probably containing
50+
// no UI strings. (symlinks? fifos, sockets, devices??)
51+
continue;
52+
}
53+
}
54+
}
55+
walk(fs.opendirSync(kSrcDirName));
56+
return result;
57+
}
58+
59+
const parseOptions = {
60+
parser: {
61+
parse(src) {
62+
return flowParser.parse(src, {
63+
// Comments can't cause UI strings to appear in the app; ignore them.
64+
all_comments: false,
65+
comments: false,
66+
67+
// We use Flow enums; the parser shouldn't crash on them.
68+
enums: true,
69+
70+
// Set `tokens: true` just to work around a mysterious error.
71+
//
72+
// From the doc for this option:
73+
//
74+
// > include a list of all parsed tokens in a top-level tokens
75+
// > property
76+
//
77+
// We don't actually want this list of tokens. String literals do
78+
// get represented in the list, but as tokens, i.e., meaningful
79+
// chunks of the literal source code. They come with surrounding
80+
// quotes, escape syntax, etc:
81+
//
82+
// 'doesn\'t'
83+
// "doesn't"
84+
//
85+
// What we really want is the *value* of a string literal:
86+
//
87+
// doesn't
88+
//
89+
// and we get that from the AST.
90+
//
91+
// Anyway, we set `true` for this because otherwise I've been seeing
92+
// `parse` throw an error:
93+
//
94+
// Error: Line 72: Invalid regular expression: missing /
95+
//
96+
// TODO: Debug and/or file an issue upstream.
97+
tokens: true,
98+
});
99+
},
100+
},
101+
};
102+
103+
/**
104+
* Look at all given files and collect all strings that might be UI strings.
105+
*
106+
* The result will include non-UI strings because we can't realistically
107+
* filter them all out. That means, when the caller checks messages_en
108+
* against these strings, it could get false negatives: perhaps messages_en
109+
* has a string 'message-empty' (why would it, though), and that string
110+
* won't be flagged because it appears as an enum value in ComposeBox.
111+
*
112+
* To reduce these false negatives, we filter out low-hanging fruit, like
113+
* the string 'foo' in `import Foo from 'foo'`.
114+
*/
115+
function getPossibleUiStrings(possibleUiStringFilePaths) {
116+
const result = new Set();
117+
possibleUiStringFilePaths.forEach(filePath => {
118+
const source = fs.readFileSync(filePath).toString();
119+
const ast = parse(source, parseOptions);
120+
121+
visit(ast, {
122+
// Find nodes with type "Literal" in the AST.
123+
/* eslint-disable no-shadow */
124+
visitLiteral(path) {
125+
const { value } = path.value;
126+
127+
if (
128+
// (Non-string literals include numbers, booleans, etc.)
129+
typeof value === 'string' &&
130+
// This string isn't like 'react' in `import React from 'react'`.
131+
!n.ImportDeclaration.check(path.parent.value)
132+
) {
133+
result.add(value);
134+
}
135+
136+
// A literal is always a leaf, right? No need to call this.traverse.
137+
return false;
138+
},
139+
140+
// Find nodes with type "TemplateLiteral" in the AST. We sometimes use
141+
// template literals in UI strings for readability.
142+
/* eslint-disable no-shadow */
143+
visitTemplateLiteral(path) {
144+
if (
145+
// Translatable UI strings are unlikely to contain
146+
// sub-expressions.
147+
//
148+
// Also, if a template literal has nontrivial sub-expressions, we
149+
// can't reasonably interpret them here anyway.
150+
path.value.quasis.length === 1 &&
151+
path.value.expressions.length === 0
152+
) {
153+
result.add(path.value.quasis[0].value.cooked);
154+
}
155+
156+
return this.traverse(path);
157+
},
158+
});
159+
});
160+
return result;
161+
}
162+
163+
function main() {
164+
const possibleUiStrings = getPossibleUiStrings(getPossibleUiStringFilePaths());
165+
166+
// Check each key ("message ID" in formatjs's lingo) against
167+
// possibleUiStrings, and make a list of any that aren't found.
168+
const danglingMessageIds = Object.keys(messages_en).filter(
169+
messageId => !possibleUiStrings.has(messageId),
170+
);
171+
172+
if (danglingMessageIds.length > 0) {
173+
console.error(
174+
"Found message IDs in static/translations/messages_en.json that don't seem to be used in the app:",
175+
);
176+
console.error(danglingMessageIds);
177+
process.exit(1);
178+
}
179+
}
180+
181+
main();

‎yarn.lock‎

Lines changed: 75 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3207,6 +3207,16 @@ asap@~2.0.3, asap@~2.0.6:
32073207
resolved "https://registry.yarnpkg.com/asap/-/asap-2.0.6.tgz#e50347611d7e690943208bbdafebcbc2fb866d46"
32083208
integrity sha512-BSHWgDSAiKs50o2Re8ppvp3seVHXSRM44cdSsT9FfNEUUZLOGWVCsiWaRPWM1Znn+mqZ1OfVZ3z3DWEzSp7hRA==
32093209

3210+
assert@^2.0.0:
3211+
version "2.0.0"
3212+
resolved "https://registry.yarnpkg.com/assert/-/assert-2.0.0.tgz#95fc1c616d48713510680f2eaf2d10dd22e02d32"
3213+
integrity sha512-se5Cd+js9dXJnu6Ag2JFc00t+HmHOen+8Q+L7O9zI0PqQXr20uk2J0XQqMxZEeo5U50o8Nvmmx7dZrl+Ufr35A==
3214+
dependencies:
3215+
es6-object-assign "^1.1.0"
3216+
is-nan "^1.2.1"
3217+
object-is "^1.0.1"
3218+
util "^0.12.0"
3219+
32103220
assign-symbols@^1.0.0:
32113221
version "1.0.0"
32123222
resolved "https://registry.yarnpkg.com/assign-symbols/-/assign-symbols-1.0.0.tgz#59667f41fadd4f20ccbc2bb96b8d4f7f78ec0367"
@@ -3224,6 +3234,20 @@ [email protected]:
32243234
dependencies:
32253235
tslib "^2.0.1"
32263236

3237+
[email protected]:
3238+
version "0.15.2"
3239+
resolved "https://registry.yarnpkg.com/ast-types/-/ast-types-0.15.2.tgz#39ae4809393c4b16df751ee563411423e85fb49d"
3240+
integrity sha512-c27loCv9QkZinsa5ProX751khO9DJl/AcB5c2KNtA6NRvHKS0PgLfcftz72KVq504vB0Gku5s2kUZzDBvQWvHg==
3241+
dependencies:
3242+
tslib "^2.0.1"
3243+
3244+
ast-types@^0.16.1:
3245+
version "0.16.1"
3246+
resolved "https://registry.yarnpkg.com/ast-types/-/ast-types-0.16.1.tgz#7a9da1617c9081bc121faafe91711b4c8bb81da2"
3247+
integrity sha512-6t10qk83GOG8p0vKmaCr8eiilZwO171AvbROMtvvNiwrTly62t+7XkA8RdIIVbpMhCASAsxgAzdRSwh6nw/5Dg==
3248+
dependencies:
3249+
tslib "^2.0.1"
3250+
32273251
"ast-types@npm:@gregprice/ast-types@^0.15.3-0.tsflower.5":
32283252
version "0.15.3-0.tsflower.5"
32293253
resolved "https://registry.yarnpkg.com/@gregprice/ast-types/-/ast-types-0.15.3-0.tsflower.5.tgz#59bfaf5b776dc8bf3e9de7d94d5a9546f3a1b6df"
@@ -4942,6 +4966,11 @@ es-to-primitive@^1.2.1:
49424966
is-date-object "^1.0.1"
49434967
is-symbol "^1.0.2"
49444968

4969+
es6-object-assign@^1.1.0:
4970+
version "1.1.0"
4971+
resolved "https://registry.yarnpkg.com/es6-object-assign/-/es6-object-assign-1.1.0.tgz#c2c3582656247c39ea107cb1e6652b6f9f24523c"
4972+
integrity sha512-MEl9uirslVwqQU369iHNWZXsI8yaZYGg/D65aOgZkeyFJwHYSxilf7rQzXKI7DdDuBPrBXbfk3sl9hJhmd5AUw==
4973+
49454974
escalade@^3.1.1:
49464975
version "3.1.1"
49474976
resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.1.1.tgz#d8cfdc7000965c5a0174b4a82eaa5c0552742e40"
@@ -5831,6 +5860,11 @@ flow-parser@0.*:
58315860
resolved "https://registry.yarnpkg.com/flow-parser/-/flow-parser-0.192.0.tgz#e2aa03e0c6a844c4d6ccdb4af2bc83cc589d9c8c"
58325861
integrity sha512-FLyei0ikf4ab9xlg+05WNmdpOODiH9XVBuw7iI9OZyjIo+cX2L2OUPTovjbWLYLlI41oGTcprbKdB/f9XwBnKw==
58335862

5863+
flow-parser@<0.159.0:
5864+
version "0.158.0"
5865+
resolved "https://registry.yarnpkg.com/flow-parser/-/flow-parser-0.158.0.tgz#d845f167c722babe880110fc3681c44f21823399"
5866+
integrity sha512-0hMsPkBTRrkII/0YiG9ehOxFXy4gOWdk8RSRze5WbfeKAQpL5kC2K4BmumyTfU9o5gr7/llgElF3UpSSrjzQAA==
5867+
58345868
flow-parser@^0.121.0:
58355869
version "0.121.0"
58365870
resolved "https://registry.yarnpkg.com/flow-parser/-/flow-parser-0.121.0.tgz#9f9898eaec91a9f7c323e9e992d81ab5c58e618f"
@@ -6749,7 +6783,7 @@ is-accessor-descriptor@^1.0.0:
67496783
dependencies:
67506784
kind-of "^6.0.0"
67516785

6752-
is-arguments@^1.1.0, is-arguments@^1.1.1:
6786+
is-arguments@^1.0.4, is-arguments@^1.1.0, is-arguments@^1.1.1:
67536787
version "1.1.1"
67546788
resolved "https://registry.yarnpkg.com/is-arguments/-/is-arguments-1.1.1.tgz#15b3f88fda01f2a97fec84ca761a560f123efa9b"
67556789
integrity sha512-8Q7EARjzEnKpt/PCD7e1cgUS0a6X8u5tdSiMqXhojOdoV9TsMsiO+9VLC5vAmO8N7/GmXn7yjR8qnA6bVAEzfA==
@@ -6906,6 +6940,13 @@ is-generator-fn@^2.0.0:
69066940
resolved "https://registry.yarnpkg.com/is-generator-fn/-/is-generator-fn-2.1.0.tgz#7d140adc389aaf3011a8f2a2a4cfa6faadffb118"
69076941
integrity sha512-cTIB4yPYL/Grw0EaSzASzg6bBy9gqCofvWN8okThAYIxKJZC+udlRAmGbM0XLeniEJSs8uEgHPGuHSe1XsOLSQ==
69086942

6943+
is-generator-function@^1.0.7:
6944+
version "1.0.10"
6945+
resolved "https://registry.yarnpkg.com/is-generator-function/-/is-generator-function-1.0.10.tgz#f1558baf1ac17e0deea7c0415c438351ff2b3c72"
6946+
integrity sha512-jsEjy9l3yiXEQ+PsXdmBwEPcOxaXWLspKdplFUVI9vq1iZgIekeC0L167qeu86czQaxed3q/Uzuw0swL0irL8A==
6947+
dependencies:
6948+
has-tostringtag "^1.0.0"
6949+
69096950
is-glob@^2.0.0:
69106951
version "2.0.1"
69116952
resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-2.0.1.tgz#d096f926a3ded5600f3fdfd91198cb0888c2d863"
@@ -6947,6 +6988,14 @@ is-module@^1.0.0:
69476988
resolved "https://registry.yarnpkg.com/is-module/-/is-module-1.0.0.tgz#3258fb69f78c14d5b815d664336b4cffb6441591"
69486989
integrity sha512-51ypPSPCoTEIN9dy5Oy+h4pShgJmPCygKfyRCISBI+JoWT/2oJvK8QPxmwv7b/p239jXrm9M1mlQbyKJ5A152g==
69496990

6991+
is-nan@^1.2.1:
6992+
version "1.3.2"
6993+
resolved "https://registry.yarnpkg.com/is-nan/-/is-nan-1.3.2.tgz#043a54adea31748b55b6cd4e09aadafa69bd9e1d"
6994+
integrity sha512-E+zBKpQ2t6MEo1VsonYmluk9NxGrbzpeeLC2xIViuO2EjU2xsXsBPwTr3Ykv9l08UYEVEdWeRZNouaZqF6RN0w==
6995+
dependencies:
6996+
call-bind "^1.0.0"
6997+
define-properties "^1.1.3"
6998+
69506999
is-negative-zero@^2.0.2:
69517000
version "2.0.2"
69527001
resolved "https://registry.yarnpkg.com/is-negative-zero/-/is-negative-zero-2.0.2.tgz#7bf6f03a28003b8b3965de3ac26f664d765f3150"
@@ -7057,7 +7106,7 @@ is-symbol@^1.0.2, is-symbol@^1.0.3:
70577106
dependencies:
70587107
has-symbols "^1.0.2"
70597108

7060-
is-typed-array@^1.1.10:
7109+
is-typed-array@^1.1.10, is-typed-array@^1.1.3:
70617110
version "1.1.10"
70627111
resolved "https://registry.yarnpkg.com/is-typed-array/-/is-typed-array-1.1.10.tgz#36a5b5cb4189b575d1a3e4b08536bfb485801e3f"
70637112
integrity sha512-PJqgEHiWZvMpaFZ3uTc8kHPM4+4ADTlDniuQL7cU/UDA0Ql7F70yGfHph3cLNe+c9toaigv+DFzTJKhc2CtO6A==
@@ -9394,7 +9443,7 @@ object-inspect@^1.12.2, object-inspect@^1.9.0:
93949443
resolved "https://registry.yarnpkg.com/object-inspect/-/object-inspect-1.12.2.tgz#c0641f26394532f28ab8d796ab954e43c009a8ea"
93959444
integrity sha512-z+cPxW0QGUp0mcqcsgQyLVRDoXFQbXOwBaqyF7VIgI4TWNQsDHrBpUQslRmIfAoYWdYzs6UlKJtB2XJpTaNSpQ==
93969445

9397-
object-is@^1.1.5:
9446+
object-is@^1.0.1, object-is@^1.1.5:
93989447
version "1.1.5"
93999448
resolved "https://registry.yarnpkg.com/object-is/-/object-is-1.1.5.tgz#b9deeaa5fc7f1846a0faecdceec138e5778f53ac"
94009449
integrity sha512-3cyDsyHgtmi7I7DfSSI2LDp6SK2lwvtbg0p0R1e0RvTqF5ceGx+K2dfSjm1bKDMVCFEDAQvy+o8c6a7VujOddw==
@@ -10475,6 +10524,17 @@ recast@^0.20.4:
1047510524
source-map "~0.6.1"
1047610525
tslib "^2.0.1"
1047710526

10527+
recast@^0.22.0:
10528+
version "0.22.0"
10529+
resolved "https://registry.yarnpkg.com/recast/-/recast-0.22.0.tgz#1dd3bf1b86e5eb810b044221a1a734234ed3e9c0"
10530+
integrity sha512-5AAx+mujtXijsEavc5lWXBPQqrM4+Dl5qNH96N2aNeuJFUzpiiToKPsxQD/zAIJHspz7zz0maX0PCtCTFVlixQ==
10531+
dependencies:
10532+
assert "^2.0.0"
10533+
ast-types "0.15.2"
10534+
esprima "~4.0.0"
10535+
source-map "~0.6.1"
10536+
tslib "^2.0.1"
10537+
1047810538
"recast@npm:@gregprice/recast@^0.21.2-0.tsflower.8":
1047910539
version "0.21.2-0.tsflower.8"
1048010540
resolved "https://registry.yarnpkg.com/@gregprice/recast/-/recast-0.21.2-0.tsflower.8.tgz#576b7329a3cb6fcd1e406ebded7daf3cd5d9f573"
@@ -12262,6 +12322,17 @@ util.promisify@~1.0.0:
1226212322
has-symbols "^1.0.1"
1226312323
object.getownpropertydescriptors "^2.1.0"
1226412324

12325+
util@^0.12.0:
12326+
version "0.12.5"
12327+
resolved "https://registry.yarnpkg.com/util/-/util-0.12.5.tgz#5f17a6059b73db61a875668781a1c2b136bd6fbc"
12328+
integrity sha512-kZf/K6hEIrWHI6XqOFUiiMa+79wE/D8Q+NCNAWclkyg3b4d2k7s0QGepNjiABc+aR3N1PAyHL7p6UcLY6LmrnA==
12329+
dependencies:
12330+
inherits "^2.0.3"
12331+
is-arguments "^1.0.4"
12332+
is-generator-function "^1.0.7"
12333+
is-typed-array "^1.1.3"
12334+
which-typed-array "^1.1.2"
12335+
1226512336
[email protected]:
1226612337
version "0.2.1"
1226712338
resolved "https://registry.yarnpkg.com/utile/-/utile-0.2.1.tgz#930c88e99098d6220834c356cbd9a770522d90d7"
@@ -12467,7 +12538,7 @@ which-module@^2.0.0:
1246712538
resolved "https://registry.yarnpkg.com/which-module/-/which-module-2.0.0.tgz#d9ef07dce77b9902b8a3a8fa4b31c3e3f7e6e87a"
1246812539
integrity sha512-B+enWhmw6cjfVC7kS8Pj9pCrKSc5txArRyaYGe088shv/FGWH+0Rjx/xPgtsWfsUtS27FkP697E4DDhgrgoc0Q==
1246912540

12470-
which-typed-array@^1.1.8:
12541+
which-typed-array@^1.1.2, which-typed-array@^1.1.8:
1247112542
version "1.1.9"
1247212543
resolved "https://registry.yarnpkg.com/which-typed-array/-/which-typed-array-1.1.9.tgz#307cf898025848cf995e795e8423c7f337efbde6"
1247312544
integrity sha512-w9c4xkx6mPidwp7180ckYWfMmvxpjlZuIudNtDf4N/tTAUB8VJbX25qZoAsrtGuYNnGw3pa0AXgbGKRB8/EceA==

0 commit comments

Comments
 (0)