Merge pull request #697 from OpenClinica/revert-694-revert-691-merge/6.2.0

Revert "Revert "Merge/6.2.0""

Author: kkrumlian

.eslintrc.json

@@ -9,12 +9,27 @@
         "structuredClone": true
     },
     "extends": ["airbnb", "prettier"],
-    "plugins": ["chai-friendly", "jsdoc", "prettier", "unicorn"],
+    "plugins": [
+        "chai-friendly",
+        "jsdoc",
+        "prettier",
+        "unicorn",
+        "@typescript-eslint"
+    ],
+    "parser": "@typescript-eslint/parser",
     "parserOptions": {
         "sourceType": "module",
         "ecmaVersion": 2021
     },
     "settings": {
+        "import/parsers": {
+            "@typescript-eslint/parser": [".js", ".ts", ".tsx"]
+        },
+        "import/resolver": {
+            "typescript": {
+                "alwaysTryTypes": true
+            }
+        },
         "jsdoc": {
             "tagNamePreference": {
                 "returns": "return"
@@ -31,7 +46,8 @@
                     "enketo/widgets",
                     "enketo/translator",
                     "enketo/dialog",
-                    "enketo/file-manager"
+                    "enketo/file-manager",
+                    "enketo-transformer/web"
                 ]
             }
         ],

CHANGELOG.md

@@ -6,7 +6,7 @@ module.exports = (grunt) => {
         '!.nyc_output',
         '!**/node_modules/**',
         '!test/client/forms/forms.js',
-        '!public/js/build/*',
+        '!public/js/build/**',
         '!docs/**',
         '!test-coverage/**',
     ];
@@ -105,7 +105,7 @@ module.exports = (grunt) => {
                     'find locales -name "translation-combined.json" -delete && rm -fr locales/??',
             },
             'clean-js': {
-                command: 'rm -f public/js/build/* && rm -f public/js/*.js',
+                command: 'rm -rf public/js/build/* && rm -f public/js/*.js',
             },
             translation: {
                 command:

Gruntfile.js

@@ -8,7 +8,7 @@ const request = require('request');
 const express = require('express');
 
 const router = express.Router();
-const debug = require('debug')('media-controller');
+const debug = require('debug')('enketo:media-controller');
 const {
     RequestFilteringHttpAgent,
     RequestFilteringHttpsAgent,

README.md

@@ -4,7 +4,7 @@
 
 const transformer = require('enketo-transformer');
 const communicator = require('../lib/communicator');
-const { TranslatedError } = require('../lib/custom-error');
+const { ResponseError, TranslatedError } = require('../lib/custom-error');
 const surveyModel = require('../models/survey-model');
 const cacheModel = require('../models/cache-model');
 const account = require('../models/account-model');
@@ -13,7 +13,6 @@ const config = require('../models/config-model').server;
 const utils = require('../lib/utils');
 const routerUtils = require('../lib/router-utils');
 const express = require('express');
-const url = require('url');
 const mediaLib = require('../lib/media');
 
 const router = express.Router();
@@ -101,27 +100,15 @@ async function getSurveyParts(req, res, next) {
     /** @type {string | null} */
     let formId = null;
 
-    /** @type {string | null} */
-    let formFileName = null;
-
     try {
         let survey = await _getSurveyParams(req);
 
-        // A request with "xformUrl" body parameter was used (unlaunched form)
-        if (survey.info != null) {
-            formFileName = survey.info.downloadUrl.replace(
-                /.*\/([^/]+)$/,
-                '$1'
-            );
-            survey = await _getFormDirectly(survey);
-
-            _respond(res, survey);
+        formId = survey.openRosaId;
 
-            return;
+        if (formId == null) {
+            throw new ResponseError(404);
         }
 
-        formId = survey.openRosaId;
-
         const authenticated = await _authenticate(survey);
         const cached = await _getFormFromCache(authenticated);
 
@@ -142,14 +129,10 @@ async function getSurveyParts(req, res, next) {
         });
     } catch (error) {
         if (error.status === 403) {
-            const notFoundError =
-                formId == null
-                    ? new TranslatedError('error.notfounddirectformurl', {
-                          formFileName,
-                      })
-                    : new TranslatedError('error.notfoundinformlist', {
-                          formId,
-                      });
+            const notFoundError = new TranslatedError(
+                'error.notfoundinformlist',
+                { formId }
+            );
 
             notFoundError.status = 404;
 
@@ -183,17 +166,6 @@ function getSurveyHash(req, res, next) {
         .catch(next);
 }
 
-/**
- * @param {module:survey-model~SurveyObject} survey - survey object
- *
- * @return { Promise<module:survey-model~SurveyObject> } a Promise resolving with survey object with form transformation result
- *
- */
-function _getFormDirectly(survey) {
-    survey.openclinica = true;
-    return communicator.getXForm(survey).then(transformer.transform);
-}
-
 /**
  * @param {module:survey-model~SurveyObject} survey - survey object
  *
@@ -233,8 +205,11 @@ function _updateCache(survey) {
                 delete survey.mediaHash;
                 delete survey.mediaUrlHash;
                 delete survey.formHash;
-
-                return _getFormDirectly(survey).then(cacheModel.set);
+                survey.openclinica = true;
+                return communicator
+                    .getXForm(survey)
+                    .then(transformer.transform)
+                    .then(cacheModel.set);
             }
 
             return survey;
@@ -359,7 +334,6 @@ function _setCookieAndCredentials(survey, req) {
  * @return { Promise<module:survey-model~SurveyObject> } a Promise resolving with survey object
  */
 function _getSurveyParams(req) {
-    const params = req.body;
     const customParamName = req.app.get(
         'query parameter to pass to submission'
     );
@@ -376,32 +350,7 @@ function _getSurveyParams(req) {
                 return _setCookieAndCredentials(survey, req);
             });
     }
-    if (params.xformUrl) {
-        const urlObj = url.parse(params.xformUrl);
-        if (!urlObj || !urlObj.protocol || !urlObj.host) {
-            const error = new Error('Bad Request. Form URL is invalid.');
-            error.status = 400;
-            throw error;
-        }
-        const xUrl = `${urlObj.protocol}//${urlObj.host}${urlObj.pathname}`;
-
-        return account
-            .check({
-                openRosaServer: xUrl,
-            })
-            .then(
-                (
-                    survey // no need to check quota
-                ) =>
-                    Promise.resolve({
-                        info: {
-                            downloadUrl: params.xformUrl,
-                        },
-                        account: survey.account,
-                    })
-            )
-            .then((survey) => _setCookieAndCredentials(survey, req));
-    }
+
     const error = new Error('Bad Request. Survey information not complete.');
     error.status = 400;
     throw error;

app/controllers/media-controller.js

@@ -6,7 +6,7 @@ const request = require('request');
 const { Auth } = require('request/lib/auth');
 const TError = require('./custom-error').TranslatedError;
 const config = require('../models/config-model').server;
-const debug = require('debug')('openrosa-communicator');
+const debug = require('debug')('enketo:openrosa-communicator');
 const Xml2Js = require('xml2js');
 
 const parser = new Xml2Js.Parser();

app/controllers/transformation-controller.js

@@ -121,6 +121,7 @@ async function get(
             },
             scale,
             printBackground: true,
+            timeout,
         });
     } catch (e) {
         e.status = e.status || 400;

app/lib/communicator.js

@@ -9,7 +9,7 @@ const utils = require('../lib/utils');
 
 const prefix = 'ca:';
 const expiry = 30 * 24 * 60 * 60;
-const debug = require('debug')('cache-model');
+const debug = require('debug')('enketo:cache-model');
 
 const clientGet = promisify(cacheClient.get).bind(cacheClient);
 const clientSet = promisify(cacheClient.set).bind(cacheClient);

app/lib/pdf.js

@@ -8,7 +8,7 @@ const TError = require('../lib/custom-error').TranslatedError;
 const config = require('./config-model').server;
 
 const pending = {};
-const debug = require('debug')('survey-model');
+const debug = require('debug')('enketo:survey-model');
 
 /**
  * @typedef {import('./account-model').AccountObj} AccountObj

app/models/cache-model.js

@@ -57,6 +57,8 @@ block content
             li= t("langs.sv")
           when "lo"
             li= t("langs.lo")
+          when "uk"
+            li= t("langs.uk")
           when "sk"
             li= t("langs.sk")
           when "tr"

app/models/survey-model.js

@@ -20,7 +20,7 @@ block style
 
 block script
   - var suffix = (type && type !== 'single') ? '-' + (type === 'full' || type === 'preview' || type === 'fieldsubmission' ? 'oc' : type): ''
-    script#main-script(defer, module, src=`${basePath}${offlinePath || ''}/js/build/enketo-webform${suffix}.js`)
+    script#main-script(defer, type='module', src=`${basePath}${offlinePath || ''}/js/build/enketo-webform${suffix}.js`)
 
   -// load jini stuff asynchronously (OC)
   if jini && !headless

app/views/index.pug

@@ -1,29 +1,28 @@
-const alias = require('esbuild-plugin-alias');
+// @ts-check
+
 const path = require('path');
 const pkg = require('../package.json');
 
 const cwd = process.cwd();
 
 const entryPoints = pkg.entries.map((entry) => path.resolve(cwd, entry));
 
-const isProduction = process.env.NODE_ENV === 'production';
-
-module.exports = {
+module.exports = /** @satisfies {import('esbuild').BuildOptions} */ ({
+    alias: Object.fromEntries(
+        Object.entries(pkg.browser).map(([key, value]) => [
+            key,
+            path.resolve(cwd, `${value}.js`),
+        ])
+    ),
     bundle: true,
+    chunkNames: 'chunks/[name]-[hash]',
     entryPoints,
-    format: 'iife',
-    minify: isProduction,
+    entryNames: '[name]',
+    external: ['crypto', 'libxslt'],
+    format: 'esm',
+    minify: true,
     outdir: path.resolve(cwd, './public/js/build'),
-    plugins: [
-        alias(
-            Object.fromEntries(
-                Object.entries(pkg.browser).map(([key, value]) => [
-                    key,
-                    path.resolve(cwd, `${value}.js`),
-                ])
-            )
-        ),
-    ],
-    sourcemap: isProduction ? false : 'inline',
+    sourcemap: true,
+    splitting: true,
     target: ['chrome89', 'edge89', 'firefox90', 'safari13'],
-};
+});

app/views/surveys/webform.pug

@@ -14,7 +14,7 @@ const errorHandler = require('../app/controllers/error-handler');
 
 const controllersPath = path.join(__dirname, '../app/controllers');
 const app = express();
-const debug = require('debug')('express');
+const debug = require('debug')('enketo:express');
 const config = require('../app/models/config-model');
 
 // general