feat: Added support for opting out endpoint translation (#56)

dzz007 · web-flow · commit dfbb5b1666ae · 2021-04-08T16:43:38.000+08:00
diff --git a/lib/cache.js b/lib/cache.js
@@ -9,6 +9,12 @@ cache.init = function() {
   file.mkdir(file.cacheDir());
 };
 
+cache.deleteAll = function () {
+  cache.list().forEach(value => {
+    cache.del(value.name);
+  })
+};
+
 cache.get = function(k) {
   const fullpath = file.cacheFile(k);
   if (!file.exist(fullpath)) return null;
diff --git a/lib/commands/list.js b/lib/commands/list.js
@@ -28,6 +28,12 @@ const cmd = {
         default:  false,
         describe: 'Show extra details: category, companies, tags.'
       })
+      .option('T', {
+        alias:    'dontTranslate',
+        type:     'boolean',
+        default:  false,
+        describe: 'Set to true to disable endpoint\'s translation',
+      })
       .positional('keyword', {
         type:     'string',
         default:  '',
diff --git a/lib/commands/show.js b/lib/commands/show.js
@@ -57,6 +57,12 @@ const cmd = {
         default:  false,
         describe: 'Show extra question details in source code'
       })
+      .option('T', {
+        alias:    'dontTranslate',
+        type:     'boolean',
+        default:  false,
+        describe: 'Set to true to disable endpoint\'s translation',
+      })
       .positional('keyword', {
         type:     'string',
         default:  '',
@@ -175,7 +181,7 @@ cmd.handler = function(argv) {
   session.argv = argv;
   if (argv.keyword.length > 0) {
     // show specific one
-    core.getProblem(argv.keyword, function(e, problem) {
+    core.getProblem(argv.keyword, !argv.dontTranslate, function(e, problem) {
       if (e) return log.fail(e);
       showProblem(problem, argv);
     });
@@ -194,7 +200,7 @@ cmd.handler = function(argv) {
       if (problems.length === 0) return log.fail('Problem not found!');
 
       const problem = _.sample(problems);
-      core.getProblem(problem, function(e, problem) {
+      core.getProblem(problem, !argv.dontTranslate, function(e, problem) {
         if (e) return log.fail(e);
         showProblem(problem, argv);
       });
diff --git a/lib/commands/star.js b/lib/commands/star.js
@@ -29,7 +29,8 @@ const cmd = {
 
 cmd.handler = function(argv) {
   session.argv = argv;
-  core.getProblem(argv.keyword, function(e, problem) {
+  // translation doesn't affect question lookup
+  core.getProblem(argv.keyword, true, function(e, problem) {
     if (e) return log.fail(e);
 
     core.starProblem(problem, !argv.delete, function(e, starred) {
diff --git a/lib/commands/submission.js b/lib/commands/submission.js
@@ -42,6 +42,12 @@ const cmd = {
         default:  false,
         describe: 'Show extra question details in submission code'
       })
+      .option('T', {
+        alias:    'dontTranslate',
+        type:     'boolean',
+        default:  false,
+        describe: 'Set to true to disable endpoint\'s translation',
+      })
       .positional('keyword', {
         type:     'string',
         default:  '',
@@ -69,7 +75,7 @@ function doTask(problem, queue, cb) {
 
   if (argv.extra) {
     // have to get problem details, e.g. problem description.
-    core.getProblem(problem.fid, function(e, problem) {
+    core.getProblem(problem.fid, !argv.dontTranslate, function(e, problem) {
       if (e) return cb(e);
       exportSubmission(problem, argv, onTaskDone);
     });
@@ -135,7 +141,7 @@ cmd.handler = function(argv) {
   if (!argv.keyword)
     return log.fail('missing keyword?');
 
-  core.getProblem(argv.keyword, function(e, problem) {
+  core.getProblem(argv.keyword, !argv.dontTranslate, function(e, problem) {
     if (e) return log.fail(e);
     q.addTask(problem).run();
   });
diff --git a/lib/commands/submit.js b/lib/commands/submit.js
@@ -49,7 +49,8 @@ cmd.handler = function(argv) {
 
   const meta = file.meta(argv.filename);
 
-  core.getProblem(meta.id, function(e, problem) {
+  // translation doesn't affect problem lookup
+  core.getProblem(meta.id, true, function(e, problem) {
     if (e) return log.fail(e);
 
     problem.file = argv.filename;
diff --git a/lib/commands/test.js b/lib/commands/test.js
@@ -60,7 +60,7 @@ function runTest(argv) {
 
   const meta = file.meta(argv.filename);
 
-  core.getProblem(meta.id, function(e, problem) {
+  core.getProblem(meta.id, true, function(e, problem) {
     if (e) return log.fail(e);
 
     if (!problem.testable)
diff --git a/lib/core.js b/lib/core.js
@@ -61,7 +61,7 @@ const QUERY_HANDLERS = {
 };
 
 core.filterProblems = function(opts, cb) {
-  this.getProblems(function(e, problems) {
+  this.getProblems(!opts.dontTranslate, function(e, problems) {
     if (e) return cb(e);
 
     for (let q of (opts.query || '').split('')) {
@@ -82,11 +82,11 @@ core.filterProblems = function(opts, cb) {
   });
 };
 
-core.getProblem = function(keyword, cb) {
+core.getProblem = function(keyword, needTranslation, cb) {
   if (keyword.id)
-    return core.next.getProblem(keyword, cb);
+    return core.next.getProblem(keyword, needTranslation, cb);
 
-  this.getProblems(function(e, problems) {
+  this.getProblems(needTranslation, function(e, problems) {
     if (e) return cb(e);
 
     keyword = Number(keyword) || keyword;	
@@ -95,7 +95,7 @@ core.getProblem = function(keyword, cb) {
       return x.fid + '' === keyword + '' || x.fid + '' === metaFid + '' || x.name === keyword || x.slug === keyword;
     });
     if (!problem) return cb('Problem not found!');
-    core.next.getProblem(problem, cb);
+    core.next.getProblem(problem, needTranslation, cb);
   });
 };
 
diff --git a/lib/helper.js b/lib/helper.js
@@ -52,11 +52,12 @@ const LANGS = [
 const h = {};
 
 h.KEYS = {
-  user:     '../user',
-  stat:     '../stat',
-  plugins:  '../../plugins',
-  problems: 'problems',
-  problem:  p => p.fid + '.' + p.slug + '.' + p.category
+  user:        '../user',
+  stat:        '../stat',
+  plugins:     '../../plugins',
+  problems:    'problems',
+  translation: 'translationConfig',
+  problem:     p => p.fid + '.' + p.slug + '.' + p.category
 };
 
 h.prettyState = function(state) {
diff --git a/lib/plugins/cache.js b/lib/plugins/cache.js
@@ -9,22 +9,37 @@ var session = require('../session');
 
 const plugin = new Plugin(50, 'cache', '', 'Plugin to provide local cache.');
 
-plugin.getProblems = function(cb) {
+// this function will clear all caches if needTranslation is different than stored
+// it will also store the new needTranslation into cache automatically
+function clearCacheIfTchanged(needTranslation) {
+  const translationConfig = cache.get(h.KEYS.translation);
+  if (!translationConfig || translationConfig['useEndpointTranslation'] != needTranslation) {
+    // cache doesn't have the key => old cache version, need to update
+    // or cache does have the key but it contains a different value
+    cache.deleteAll();
+    cache.set(h.KEYS.translation, { useEndpointTranslation: needTranslation });
+    log.debug('cache cleared: -T option changed');
+  }
+}
+
+plugin.getProblems = function (needTranslation, cb) {
+  clearCacheIfTchanged(needTranslation);
   const problems = cache.get(h.KEYS.problems);
   if (problems) {
     log.debug('cache hit: problems.json');
     return cb(null, problems);
   }
 
-  plugin.next.getProblems(function(e, problems) {
+  plugin.next.getProblems(needTranslation, function(e, problems) {
     if (e) return cb(e);
 
     cache.set(h.KEYS.problems, problems);
     return cb(null, problems);
   });
 };
 
-plugin.getProblem = function(problem, cb) {
+plugin.getProblem = function (problem, needTranslation, cb) {
+  clearCacheIfTchanged(needTranslation);
   const k = h.KEYS.problem(problem);
   const _problem = cache.get(k);
   if (_problem) {
@@ -42,7 +57,7 @@ plugin.getProblem = function(problem, cb) {
     }
   }
 
-  plugin.next.getProblem(problem, function(e, _problem) {
+  plugin.next.getProblem(problem, needTranslation, function(e, _problem) {
     if (e) return cb(e);
 
     plugin.saveProblem(_problem);
diff --git a/lib/plugins/company.js b/lib/plugins/company.js
@@ -1511,8 +1511,8 @@ var TAGS = {
   '1148': ['math']
 };
 
-plugin.getProblems = function(cb) {
-  plugin.next.getProblems(function(e, problems) {
+plugin.getProblems = function(needTranslation, cb) {
+  plugin.next.getProblems(needTranslation, function(e, problems) {
     if (e) return cb(e);
 
     problems.forEach(function(problem) {
diff --git a/lib/plugins/leetcode.cn.js b/lib/plugins/leetcode.cn.js
@@ -70,21 +70,29 @@ function checkError(e, resp, expectedStatus) {
   return e;
 }
 
-plugin.getProblems = function(cb) {
-  plugin.next.getProblems(function(e, problems) {
+// overloading getProblems here to make sure everything related 
+//   to listing out problems can have a chance to be translated. 
+// NOTE: Details of the problem is translated inside leetcode.js
+plugin.getProblems = function (needTranslation, cb) {
+  plugin.next.getProblems(needTranslation, function(e, problems) {
     if (e) return cb(e);
 
-    plugin.getProblemsTitle(function(e, titles) {
-      if (e) return cb(e);
+    if (needTranslation) {
+      // only translate titles of the list if user requested
+      plugin.getProblemsTitle(function (e, titles) {
+        if (e) return cb(e);
 
-      problems.forEach(function(problem) {
-        const title = titles[problem.id];
-        if (title)
-          problem.name = title;
-      });
+        problems.forEach(function (problem) {
+          const title = titles[problem.id];
+          if (title)
+            problem.name = title;
+        });
 
+        return cb(null, problems);
+      });
+    } else {
       return cb(null, problems);
-    });
+    }
   });
 };
 
diff --git a/lib/plugins/leetcode.js b/lib/plugins/leetcode.js
@@ -54,7 +54,7 @@ plugin.init = function() {
   config.app = 'leetcode';
 };
 
-plugin.getProblems = function(cb) {
+plugin.getProblems = function (needTranslation, cb) {
   log.debug('running leetcode.getProblems');
   let problems = [];
   const getCategory = function(category, queue, cb) {
@@ -117,7 +117,7 @@ plugin.getCategoryProblems = function(category, cb) {
   });
 };
 
-plugin.getProblem = function(problem, cb) {
+plugin.getProblem = function(problem, needTranslation, cb) {
   log.debug('running leetcode.getProblem');
   const user = session.getUser();
   if (problem.locked && !user.paid) return cb('failed to load locked problem!');
@@ -161,7 +161,7 @@ plugin.getProblem = function(problem, cb) {
     problem.likes = q.likes;
     problem.dislikes = q.dislikes;
 
-    problem.desc = q.translatedContent ? q.translatedContent : q.content;
+    problem.desc = (q.translatedContent && needTranslation) ? q.translatedContent : q.content;
 
     problem.templates = JSON.parse(q.codeDefinition);
     problem.testcase = q.sampleTestCase;
diff --git a/lib/plugins/solution.discuss.js b/lib/plugins/solution.discuss.js
@@ -71,8 +71,8 @@ function getSolution(problem, lang, cb) {
   });
 }
 
-plugin.getProblem = function(problem, cb) {
-  plugin.next.getProblem(problem, function(e, problem) {
+plugin.getProblem = function(problem, needTranslation, cb) {
+  plugin.next.getProblem(problem, needTranslation, function(e, problem) {
     if (e || !session.argv.solution) return cb(e, problem);
 
     var lang = session.argv.lang;
diff --git a/test/plugins/test_cache.js b/test/plugins/test_cache.js
diff --git a/test/plugins/test_leetcode.js b/test/plugins/test_leetcode.js
diff --git a/test/test_core.js b/test/test_core.js
