Test npm

.github/dependabot.yml

@@ -48,9 +48,21 @@ updates:
     time: "02:00"
     timezone: America/Chicago
   open-pull-requests-limit: 99
+  allow:
+    - dependency-type: indirect
   reviewers:
   - Workiva/xt
+- package-ecosystem: docker
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "02:00"
+    timezone: America/Chicago
+  open-pull-requests-limit: 5
+  reviewers:
+    - Workiva/xt
+  allow:
+    - dependency-name: "python"
   ignore:
-  - dependency-name: numpy
-    versions:
-    - ">=1.20"
+    - dependency-name: "python"
+      update-types: ["version-update:semver-major", "version-update:semver-minor"]

.github/workflows/node-tests.yml

@@ -0,0 +1,31 @@
+name: Run Node Unit Tests
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - macos-12
+          - ubuntu-22.04
+          - windows-2022
+        node-version:
+          - '14'
+          - '16'
+          - '18'
+          - '19'
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/[email protected]
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies
+        run: |
+          npm install
+      - name: Test with npm
+        run: npm run test

.github/workflows/python-tests.yml

@@ -0,0 +1,35 @@
+name: Run Python Unit Tests
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - macos-12
+          - ubuntu-22.04
+          - windows-2022
+        python-version:
+          - '3.7'
+          - '3.8'
+          - '3.9'
+          - '3.10'
+          - '3.11'
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/[email protected]
+      - name: Install Python 3
+        uses: actions/[email protected]
+        with:
+          cache: 'pip'
+          check-latest: true
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip install -r requirements-dev.txt
+      - name: Test with nose2
+        run: nose2

Dockerfile

@@ -1,10 +1,18 @@
-FROM node:16-slim as node-build
+FROM node:19-slim as node-build
 
-ARG NPM_CONFIG__AUTH
-ARG NPM_CONFIG_REGISTRY=https://workivaeast.jfrog.io/workivaeast/api/npm/npm-prod/
-ARG NPM_CONFIG_ALWAYS_AUTH=true
+# ARG NPM_CONFIG__AUTH
+# ARG NPM_CONFIG_REGISTRY=https://workivaeast.jfrog.io/workivaeast/api/npm/npm-prod/
+# ARG NPM_CONFIG_ALWAYS_AUTH=true
 ARG GIT_TAG
 
+ARG NPMRC
+ARG NPM_CONFIG_USERCONFIG=/.npmrc
+RUN reg=$(echo "$NPM_CONFIG_REGISTRY" | cut -d ":" -f 2) && \
+    echo "$reg:_authToken = $NPM_CONFIG__AUTH" > /.npmrc && \
+    echo "registry = $NPM_CONFIG_REGISTRY" >> /.npmrc && \
+    echo "always-auth = true" >> /.npmrc
+
+
 WORKDIR /build/
 
 COPY package.json /build/
@@ -58,7 +66,7 @@ RUN sed -i "s/version='0\.0\.0'/version='$VERSION'/" setup.py
 # python tests
 ARG BUILD_ARTIFACTS_TEST=/test_reports/*.xml
 RUN mkdir /test_reports
-RUN nosetests --with-xunit --xunit-file=/test_reports/results.xml --cover-html tests.unit_tests
+RUN nose2 --plugin nose2.plugins.junitxml --junit-xml-path ../test_reports/results.xml
 
 # pypi package creation
 ARG BUILD_ARTIFACTS_PYPI=/build/dist/*.tar.gz

Makefile

@@ -30,7 +30,7 @@ iXBRLViewerPlugin/viewer/dist/ixbrl_viewer.js:	iXBRLViewerPlugin/viewer/src/*/*
 test: testplugin testviewer
 
 testplugin:
-	nosetests3 tests.unit_tests
+	nose2
 
 Arelle:
 	git clone https://github.com/Arelle/Arelle.git Arelle

README.md

@@ -1,4 +1,4 @@
-# Workiva iXBRL Viewer
+# Workiva iXBRL Viewer testing for Cristian
 
 The [Workiva](https://www.workiva.com) iXBRL Viewer allows [Inline XBRL](https://www.xbrl.org/ixbrl) (or iXBRL) reports to be viewed interactively in a web browser.  The viewer allows users to access the tagged XBRL data embedded in an iXBRL report.  Key features include:
 
@@ -190,4 +190,4 @@ Run the following command to run javascript unit tests: `npm run test`
 
 In order to run the python unit tests make sure that you have pip installed requirements-dev.txt.
 
-Run the following command to run python unit tests: `nosetests`
+Run the following command to run python unit tests: `nose2`

iXBRLViewerPlugin/viewer/src/html/inspector.html

@@ -180,6 +180,7 @@ <h3 class="collapsible-header" data-i18n="inspector.associatedFacts">Associated
         <span data-i18n="inspector.poweredBy">Powered by</span>
         <a href="https://www.workiva.co.uk/solutions/xbrl-and-ixbrl" target="_blank"><img alt="Workiva logo (opens in new window)" src="../img/workiva.svg" /></a>
     </div>
+    <div class="failed-to-load-mask"></div>
   </div>
   <div class="dialog-mask">
   </div>

iXBRLViewerPlugin/viewer/src/js/ixbrlviewer.js

@@ -15,15 +15,19 @@
 import interact from 'interactjs'
 import $ from 'jquery'
 import { iXBRLReport } from "./report.js";
-import { Viewer } from "./viewer.js";
+import { Viewer, DocumentTooLargeError } from "./viewer.js";
 import { Inspector } from "./inspector.js";
 
 export function iXBRLViewer(options) {
-    this.options = options || {};
     this._plugins = [];
     this.inspector = new Inspector(this);
     this.viewer = null;
-    this.options = options || {};
+    options = options || {};
+    const defaults = {
+        showValidationWarningOnStart: false,
+        continuationElementLimit: 10000
+    }
+    this.options = {...defaults, ...options};
 }
 
 /*
@@ -226,7 +230,17 @@ iXBRLViewer.prototype.load = function () {
                         if (iv.options.showValidationWarningOnStart) {
                             inspector.showValidationWarning();
                         }
-                    });
+                    })
+                    .catch(err => {
+                        if (err instanceof DocumentTooLargeError) {
+                            $('#ixv .loader').remove();
+                            $('#inspector').addClass('failed-to-load');
+                        }
+                        else {
+                            throw err;
+                        }
+
+                    })
             }
         }, 250);
     }, 0);

iXBRLViewerPlugin/viewer/src/js/messagebox.js

@@ -51,4 +51,10 @@ export class MessageBox extends Dialog {
 
         super.show(this);
     }
+
+    showAsync() {
+        return new Promise((resolve, reject) => {
+            this.show(() => resolve(true), () => resolve(false));
+        });
+    }
 }

iXBRLViewerPlugin/viewer/src/js/viewer.js

@@ -18,6 +18,9 @@ import { escapeRegex } from './util.js'
 import { IXNode } from './ixnode.js';
 import { setDefault } from './util.js';
 import { DocOrderIndex } from './docOrderIndex.js';
+import { MessageBox } from './messagebox.js';
+
+export class DocumentTooLargeError extends Error {}
 
 export function Viewer(iv, iframes, report) {
     this._iv = iv;
@@ -33,31 +36,55 @@ export function Viewer(iv, iframes, report) {
     this._currentDocumentIndex = 0;
 }
 
+Viewer.prototype._checkContinuationCount = function() {
+    const continuationCount = Object.keys(this.continuationOfMap).length
+    if (continuationCount > this._iv.options.continuationElementLimit) {
+        const contents = $('<div></div>')
+            .append($('<p></p>').text(`This document contains a very large number of iXBRL elements (found ${continuationCount} ix:continuation elements).`))
+            .append($('<p></p>').text('You may experience performance problems viewing this document, or the viewer may not load at all.'))
+            .append($('<p></p>').text('Do you want to continue trying to load this document?'));
+
+        const mb = new MessageBox("Large document warning", contents, "Continue", "Cancel");
+        return mb.showAsync().then((result) => {
+            if (!result) {
+                throw new DocumentTooLargeError("Too many continuations");
+            }
+        });
+    }
+    return Promise.resolve();
+}
+
 Viewer.prototype.initialize = function() {
-    return new Promise((resolve, reject) => {
+    return new Promise(async (resolve, reject) => {
         var viewer = this;
         viewer._buildContinuationMaps();
-        viewer._iframes.each(function (docIndex) { 
-            $(this).data("selected", docIndex == viewer._currentDocumentIndex);
-            viewer._preProcessiXBRL($(this).contents().find("body").get(0), docIndex);
-        });
-
-        /* Call plugin promise for each document in turn */
-        (async function () {
-            for (var docIndex = 0; docIndex < viewer._iframes.length; docIndex++) {
-                await viewer._iv.pluginPromise('preProcessiXBRL', viewer._iframes.eq(docIndex).contents().find("body").get(0), docIndex);
-            }
-        })()
-            .then(() => viewer._iv.setProgress("Preparing document") )
+        viewer._checkContinuationCount()
+            .catch(err => { throw err })
             .then(() => {
-                this._report.setIXNodeMap(this._ixNodeMap);
-                this._applyStyles();
-                this._bindHandlers();
-                this.scale = 1;
-                this._setTitle(0);
-                this._addDocumentSetTabs();
-                resolve();
-            });
+
+                viewer._iframes.each(function (docIndex) { 
+                    $(this).data("selected", docIndex == viewer._currentDocumentIndex);
+                    viewer._preProcessiXBRL($(this).contents().find("body").get(0), docIndex);
+                });
+
+                /* Call plugin promise for each document in turn */
+                (async function () {
+                    for (var docIndex = 0; docIndex < viewer._iframes.length; docIndex++) {
+                        await viewer._iv.pluginPromise('preProcessiXBRL', viewer._iframes.eq(docIndex).contents().find("body").get(0), docIndex);
+                    }
+                })()
+                    .then(() => viewer._iv.setProgress("Preparing document") )
+                    .then(() => {
+                        this._report.setIXNodeMap(this._ixNodeMap);
+                        this._applyStyles();
+                        this._bindHandlers();
+                        this.scale = 1;
+                        this._setTitle(0);
+                        this._addDocumentSetTabs();
+                        resolve();
+                    });
+            })
+            .catch(err => reject(err));
     });
 }
 
@@ -181,7 +208,7 @@ Viewer.prototype._findOrCreateWrapperNode = function(domNode) {
         });
     }
     nodes.each(function (i) {
-        if (this.getBoundingClientRect().height == 0) {
+        if (this.getBoundingClientRect().height == 0 && $(this).css('display') !== 'inline') {
             $(this).addClass("ixbrl-no-highlight"); 
         }
         if (i == 0) {

iXBRLViewerPlugin/viewer/src/less/inspector.less

@@ -931,6 +931,18 @@
     &.footnote-mode .footnote-mode-off {
       display: none;
     }
+
+    .failed-to-load-mask {
+      display: none;
+    }
+
+    &.failed-to-load .failed-to-load-mask {
+      display: block;
+      background-color: rgb(0 0 0 / 50%);
+      position: absolute;
+      width: 100%;
+      height: 100%;
+    }
   }
 
   .fact-link {

iXBRLViewerPlugin/viewer/webpack.common.js

@@ -52,6 +52,6 @@ module.exports = {
   },
   plugins: [
     // Ignore all locale files of moment.js
-    new webpack.IgnorePlugin(/^\.\/locale$/, /moment$/),
+    new webpack.IgnorePlugin({ resourceRegExp: /^\.\/locale$/, contextRegExp: /moment$/ }),
   ]
 };

iXBRLViewerPlugin/viewer/webpack.dev.js

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-const merge = require('webpack-merge');
+const { merge } = require('webpack-merge');
 const common = require('./webpack.common.js');
 const path = require('path');
 

iXBRLViewerPlugin/viewer/webpack.prod.js

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-const merge = require('webpack-merge');
+const { merge } = require('webpack-merge');
 const common = require('./webpack.common.js');
 const path = require('path');
 

package.json

@@ -31,7 +31,7 @@
     "babel-core": "^6.26.3",
     "babel-jest": "^26.0.1",
     "babel-preset-env": "^1.7.0",
-    "base64-inline-loader": "^1.1.1",
+    "base64-inline-loader": "^2.0.1",
     "i18next": "^20.3.2",
     "jquery-i18next": "^1.2.1",
     "chart.js": "^2.9.3",
@@ -51,9 +51,9 @@
     "postcss-less": "^6.0.0",
     "stylelint": "^14.9.1",
     "stylelint-config-standard": "^28.0.0",
-    "webpack": "^4.42.0",
-    "webpack-cli": "^3.3.11",
-    "webpack-merge": "^4.2.2"
+    "webpack": "^5.75.0",
+    "webpack-cli": "^5.0.1",
+    "webpack-merge": "^5.8.0"
   },
   "devDependencies": {
     "decimal.js": "^10.4.1",

requirements-dev.txt

@@ -1,5 +1,5 @@
 lxml>=4.6.3,<5.0.0
-mock>=4.0.3,<5.0.0
-nose>=1.3.7,<2.0.0
+mock>=4.0.3,<6.0.0
+nose2>=0.12.0,<1.0.0
 
 -r requirements.txt

requirements.txt

@@ -1,3 +1,3 @@
 isodate>=0.6.0,<0.7.0
-numpy>=1.19.5,<1.20.0
+numpy>=1.19.5,<2.0.0
 pycountry>=20.7.3,<21.0.0

tests/unit_tests/iXBRLViewerPlugin/mock_arelle.py

@@ -34,4 +34,3 @@ def mock_arelle():
             inferredDecimals=inferredDecimals_effect
         )
         sys.modules['arelle.webserver.bottle'] = Mock()
-        sys.modules['arelle.XbrlConst'] = Mock()