Merge pull request #3606 from kbase/UIP-51-fix-staging-dl-input

UIP-51 fix downloader app inputs
kbase · Jul 26, 2024 · e4668ed · e4668ed
2 parents b408b78 + 8ae5832
commit e4668ed
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 33 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -2,36 +2,38 @@
 
 The Narrative Interface allows users to craft KBase Narratives using a combination of GUI-based commands, Python and R scripts, and graphical output elements.
 
-This is built on the Jupyter Notebook v6.5.6 and IPython 8.25.0 (more notes will follow).
+This is built on the Jupyter Notebook v6.5.6 and IPython 8.26.0 (more notes will follow).
 
 ## Version 5.4.1
+- UIP-51 fix issue where JSON and STAGING download apps aren't getting properly instantiated with object inputs.
+
 ### Dependency Changes
 - Python dependency updates
   - biopython 1.79 -> 1.84
   - bokeh 3.0.3 -> 3.4.2
+  - certifi 2024.6.2 -> 2024.7.4
+  - chardet 5.0.0 -> 5.2.0
+  - ipython 8.25.0 -> 8.26.0
   - networkx 3.0 -> 3.3
   - numpy 1.24.1 -> 2.0.0
+  - pexpect 4.8.0 -> 4.9.0
+  - pillow 10.3.0 -> 10.4.0
   - plotly 5.13.0 -> 5.22.0
   - pyasn1 0.4.8 -> 0.6.0
-  - ruff 0.4.7 -> 0.5.0
   - pygments 2.17.2 -> 2.18.0
-  - pexpect 4.8.0 -> 4.9.0
-  - seaborn 0.12.0 -> 0.13.2
-  - setuptools 69.5.1 -> 70.1.1
-  - certifi 2024.6.2 -> 2024.7.4
-  - sympy 1.10.1 -> 1.12.1
-  - pillow 10.3.0 -> 10.4.0
   - python-daemon 2.3.2 -> 3.0.1
-  - chardet 5.0.0 -> 5.2.0
   - python-dateutil 2.8.2 -> 2.9.0.post0
   - scipy 1.10.0 -> 1.14.0
-  - ipython 8.25.0 -> 8.26.0
+  - seaborn 0.12.0 -> 0.13.2
+  - setuptools 69.5.1 -> 70.1.1
+  - sympy 1.10.1 -> 1.12.1
+  - ruff 0.4.7 -> 0.5.0
 
 - JavaScript dependency updates
+  - @wdio/mocha-framework  8.38.2 -> 8.39.0 
+  - chrome-launcher  1.1.1 -> 1.1.2 
   - chromedriver  126.0.0 -> 126.0.4 
   - postcss  8.4.38 -> 8.4.39 
-  - chrome-launcher  1.1.1 -> 1.1.2 
-  - @wdio/mocha-framework  8.38.2 -> 8.39.0 
   - selenium-webdriver  4.21.0 -> 4.22.0 
 
 ## Version 5.4.0

diff --git a/kbase-extension/static/kbase/js/widgets/narrative_core/kbaseNarrativeDownloadPanel.js b/kbase-extension/static/kbase/js/widgets/narrative_core/kbaseNarrativeDownloadPanel.js
@@ -76,7 +76,7 @@ define([
             $dlBtn.click(() => {
                 if (makeCell) {
                     Jupyter.narrative.addAndPopulateApp(dlInfo.appId, APIUtil.getAppVersionTag(), {
-                        input_ref: this.objName,
+                        input_ref: this.upa,
                     });
                 } else {
                     $dlBtn.parent().find('.kb-data-list-btn').prop('disabled', true);

diff --git a/test/unit/spec/narrative_core/kbaseNarrativeDownloadPanel-spec.js b/test/unit/spec/narrative_core/kbaseNarrativeDownloadPanel-spec.js
@@ -12,20 +12,20 @@ define([
 
     describe('The kbaseNarrativeDownloadPanel widget', () => {
         let $div = null;
-        const ws = 1111,
-            oid = 2222,
-            ver = 3333,
-            name = 'fake_test_object',
-            objType = 'FakeModule.FakeType',
-            upa = `${ws}/${oid}/${ver}`;
+        const WS = 1111,
+            OBJ_ID = 2222,
+            OBJ_VER = 3333,
+            OBJ_NAME = 'fake_test_object',
+            OBJ_TYPE = 'FakeModule.FakeType',
+            INPUT_UPA = `${WS}/${OBJ_ID}/${OBJ_VER}`;
 
         const initDownloadPanel = async (authToken, exporterCache) => {
             return await new kbaseNarrativeDownloadPanel($div, {
                 token: authToken,
-                type: objType,
-                objId: oid,
-                ref: upa,
-                objName: name,
+                type: OBJ_TYPE,
+                objId: OBJ_ID,
+                upa: INPUT_UPA,
+                objName: OBJ_NAME,
                 downloadSpecCache: exporterCache,
             });
         };
@@ -65,7 +65,7 @@ define([
                 const exporterCache = {
                     lastUpdateTime: 100,
                     types: {
-                        [objType]: { export_functions: exporters },
+                        [OBJ_TYPE]: { export_functions: exporters },
                     },
                 };
 
@@ -141,7 +141,7 @@ define([
                 exporterCache = {
                     lastUpdateTime: 100,
                     types: {
-                        [objType]: {
+                        [OBJ_TYPE]: {
                             export_functions: {
                                 SOME_FORMAT: exportApp,
                             },
@@ -215,7 +215,7 @@ define([
                 exporterCache = {
                     lastUpdateTime: 100,
                     types: {
-                        [objType]: {
+                        [OBJ_TYPE]: {
                             export_functions: {
                                 SOME_FORMAT: exportApp,
                             },
@@ -254,7 +254,7 @@ define([
                 exporterCache = {
                     lastUpdateTime: 100,
                     types: {
-                        [objType]: {
+                        [OBJ_TYPE]: {
                             export_functions: {
                                 SOME_FORMAT: exportApp,
                             },
@@ -355,7 +355,7 @@ define([
                 exporterCache = {
                     lastUpdateTime: 100,
                     types: {
-                        [objType]: {
+                        [OBJ_TYPE]: {
                             export_functions: {
                                 SOME_FORMAT: exportApp,
                             },
@@ -401,7 +401,7 @@ define([
             const exporterCache = {
                 lastUpdateTime: 100,
                 types: {
-                    [objType]: {
+                    [OBJ_TYPE]: {
                         export_functions: {
                             STAGING: 'gets_overwritten_right_now',
                         },
@@ -416,29 +416,29 @@ define([
             expect(Jupyter.narrative.addAndPopulateApp).toHaveBeenCalledOnceWith(
                 STAGING_EXPORT_APP,
                 'release',
-                { input_ref: 'fake_test_object' }
+                { input_ref: INPUT_UPA }
             );
         });
 
         it('Should create an app cell with the JSON exporter', async () => {
             /* use mock for Jupyter.narrative.addAndPopulateApp */
             spyOn(Jupyter.narrative, 'addAndPopulateApp');
-            await initDownloadPanel(null, { lastUpdateTime: 100, types: { [objType]: {} } });
+            await initDownloadPanel(null, { lastUpdateTime: 100, types: { [OBJ_TYPE]: {} } });
             const exportBtn = $div.find('.kb-data-list-btn');
             // only one is JSON
             expect(exportBtn.length).toEqual(1);
             exportBtn.click();
             expect(Jupyter.narrative.addAndPopulateApp).toHaveBeenCalledOnceWith(
                 JSON_EXPORT_APP,
                 'release',
-                { input_ref: 'fake_test_object' }
+                { input_ref: INPUT_UPA }
             );
         });
 
         it('Should have a cancel button that empties the widget', async () => {
             const widget = await initDownloadPanel(null, {
                 lastUpdateTime: 100,
-                types: { [objType]: {} },
+                types: { [OBJ_TYPE]: {} },
             });
             const cancelBtn = $div.find('.kb-data-list-cancel-btn');
             cancelBtn.click();