Merge pull request #310 from Developer-Autodesk/INVGEN-44551-client-side-cloud-credits

Invgen 44551 client side cloud credits

Author: slavikz-centrum

WebApplication/ClientApp/src/JobManager.js

@@ -37,12 +37,12 @@ class JobManager {
         if (onStart)
             onStart();
 
-        connection.on("onComplete", (updatedState/*, stats*/) => {
+        connection.on("onComplete", (updatedState, stats) => {
             // stop connection
             connection.stop();
 
             if (onComplete)
-                onComplete(updatedState);
+                onComplete(updatedState, stats);
         });
 
         connection.on("onError", (jobId, reportUrl) => {
@@ -62,12 +62,12 @@ class JobManager {
         if (onStart)
             onStart();
 
-        connection.on("onComplete", (newProject/*, stats*/) => {
+        connection.on("onComplete", (newProject, stats) => {
             // stop connection
             connection.stop();
 
             if (onComplete)
-                onComplete(newProject);
+                onComplete(newProject,stats);
         });
 
         connection.on("onError", (jobId, reportUrl) => {
@@ -96,7 +96,7 @@ class JobManager {
 
         if (onStart) onStart();
 
-        connection.on("onComplete", (downloadUrl/*, stats*/) => {
+        connection.on("onComplete", (downloadUrl, stats) => {
 
             connection.stop();
 
@@ -105,7 +105,7 @@ class JobManager {
                 if (token) {
                     downloadUrl += "/" + token;
                 }
-                onSuccess(downloadUrl);
+                onSuccess(downloadUrl, stats);
             }
         });
 
@@ -124,12 +124,12 @@ class JobManager {
         if (onStart)
             onStart();
 
-        connection.on("onComplete", (drawingUrl/*, stats*/) => {
+        connection.on("onComplete", (drawingUrl, stats) => {
             // stop connection
             connection.stop();
 
             if (onComplete) {
-                onComplete(drawingUrl);
+                onComplete(drawingUrl, stats);
             }
         });
 

WebApplication/ClientApp/src/actions/connectionMock.js

@@ -24,8 +24,8 @@ const connectionMock = {
     },
     invoke: function() {},
     stop: function() {},
-    simulateComplete: function(data) {
-        this.onHandlers['onComplete'](data);
+    simulateComplete: function(data, stats) {
+        this.onHandlers['onComplete'](data, stats);
     },
     simulateError: function(jobId, link) {
         this.onHandlers['onError'](jobId, link);

WebApplication/ClientApp/src/actions/downloadActions.js

@@ -18,7 +18,7 @@
 
 import { addError, addLog } from './notificationActions';
 import { Jobs } from '../JobManager';
-import { showDownloadProgress, showDownloadFailed, setDownloadLink, setReportUrlLink } from './uiFlagsActions';
+import { showDownloadProgress, showDownloadFailed, setDownloadLink, setReportUrlLink, setStats } from './uiFlagsActions';
 import { showDrawingExportProgress, setDrawingPdfUrl } from './uiFlagsActions';
 
 /**
@@ -51,10 +51,11 @@ export const getDownloadLink = (methodName, projectId, hash, dialogTitle) => asy
                 dispatch(setReportUrlLink(null)); // cleanup url link
             },
             // onComplete
-            (downloadUrl) => {
+            (downloadUrl, stats) => {
                 dispatch(addLog(`JobManager.doDownloadJob: '${methodName}' completed for project : ${projectId}`));
                 // set download link, it will show link in UI
                 dispatch(setDownloadLink(downloadUrl));
+                dispatch(setStats(stats));
             },
             // onError
             (jobId, reportUrl) => {
@@ -87,15 +88,15 @@ export const fetchDrawing = (project) => async (dispatch) => {
             // start job
             () => {
                 dispatch(addLog('JobManager.doDrawingExportJob: HubConnection started for project : ' + project.id));
+                dispatch(setStats(null));
                 //dispatch(setReportUrlLink(null)); // cleanup url link
             },
             // onComplete
-            (drawingPdfUrl) => {
+            (drawingPdfUrl, stats) => {
                 dispatch(addLog('JobManager.doDrawingExportJob: Received onComplete'));
                 // store drawings link
                 dispatch(setDrawingPdfUrl(drawingPdfUrl));
-                // hide progress modal dialog
-                dispatch(showDrawingExportProgress(false));
+                dispatch(setStats(stats));
             },
             // onError
             (jobId, reportUrl) => {

WebApplication/ClientApp/src/actions/downloadActions.test.js

@@ -29,6 +29,7 @@ const fullLink = `${aLink}/${tokenMock}`;
 const noTokenLink = `${aLink}`;
 const errorReportLink = 'https://error.link';
 const jobId = 'job1';
+const theStats = { credits: 1 };
 
 // prepare mock for signalR
 import connectionMock from './connectionMock';
@@ -71,12 +72,14 @@ describe('downloadActions', () => {
         it('check getDownloadLink onComplete action', async () => {
             await store.dispatch(downloadActions.getDownloadLink("Method", "ProjectId", "hash", "title"));
             // simulate conection.onComplete(rfaLink);
-            connectionMock.simulateComplete(aLink);
+            connectionMock.simulateComplete(aLink, theStats);
 
             // check expected store actions
             const actions = store.getActions();
             const linkAction = actions.find(a => a.type === uiFlagsActionTypes.SET_DOWNLOAD_LINK);
             expect(linkAction.url).toEqual(fullLink);
+            const statsAction = actions.find(a => a.type === uiFlagsActionTypes.SET_STATS);
+            expect(statsAction.stats).toEqual(theStats);
         });
 
         it('check getDownloadLink onError action', async () => {
@@ -94,12 +97,15 @@ describe('downloadActions', () => {
     describe('Drawing', () => {
         it('check fetchDrawing action', async () => {
             await store.dispatch(downloadActions.fetchDrawing({ id: "ProjectId" }));
-            connectionMock.simulateComplete(aLink);
+            connectionMock.simulateComplete(aLink, theStats);
 
             // check expected store actions
             const actions = store.getActions();
             const linkAction = actions.find(a => a.type === uiFlagsActionTypes.SET_DRAWING_URL);
             expect(linkAction.url).toEqual(noTokenLink);
+            // there are two setStats in the flow: clear (null) and set (theStats)
+            expect(actions.some(a => a.type === uiFlagsActionTypes.SET_STATS && a.stats === null)).toBeTruthy();
+            expect(actions.some(a => a.type === uiFlagsActionTypes.SET_STATS && a.stats === theStats)).toBeTruthy();
         });
 
         it('check fetchDrawing error handling', async () => {

WebApplication/ClientApp/src/actions/parametersActions.js

@@ -19,7 +19,7 @@
 import repo from '../Repository';
 import { addError, addLog } from './notificationActions';
 import { Jobs } from '../JobManager';
-import { showModalProgress, showUpdateFailed, setReportUrlLink } from './uiFlagsActions';
+import { showModalProgress, showUpdateFailed, setReportUrlLink, setStats } from './uiFlagsActions';
 
 import { updateProject } from './projectListActions';
 
@@ -160,12 +160,12 @@ export const updateModelWithParameters = (projectId, data) => async (dispatch) =
             () => {
                 dispatch(addLog('JobManager: HubConnection started for project : ' + projectId));
                 dispatch(setReportUrlLink(null)); // cleanup url link
+                dispatch(setStats(null));
             },
             // onComplete
-            updatedState => {
+            (updatedState, stats) => {
                 dispatch(addLog('JobManager: Received onComplete'));
-                // hide modal dialog
-                dispatch(showModalProgress(false));
+                dispatch(setStats(stats));
 
                 // parameters and "base project state" should be handled differently,
                 // so split the incoming updated state to pieces.
@@ -174,7 +174,6 @@ export const updateModelWithParameters = (projectId, data) => async (dispatch) =
                 // launch update
                 const adaptedParams = adaptParameters(parameters);
                 dispatch(updateParameters(projectId, adaptedParams));
-
                 dispatch(updateProject(projectId, baseProjectState));
             },
             // onError

WebApplication/ClientApp/src/actions/parametersActions.test.js

@@ -267,8 +267,9 @@ describe('fetchParameters', () => {
                 parameters: parameters,
                 ...projectData
             };
+            const theStats = { credits: 1 };
 
-            connectionMock.simulateComplete(updatedState);
+            connectionMock.simulateComplete(updatedState, theStats);
 
             // check expected store actions
             const actions = store.getActions();
@@ -279,6 +280,9 @@ describe('fetchParameters', () => {
             const updateProject = actions.find(a => a.type === projectListActionTypes.UPDATE_PROJECT);
             expect(updateProject.activeProjectId).toEqual(projectId);
             expect(updateProject.data).toEqual(projectData);
+            // there are two setStats in the flow: clear (null) and set (theStats)
+            expect(actions.some(a => a.type === uiFlagsActionTypes.SET_STATS && a.stats === null)).toBeTruthy();
+            expect(actions.some(a => a.type === uiFlagsActionTypes.SET_STATS && a.stats === theStats)).toBeTruthy();
         });
 
         it('check updateModelWithParameters error path', async () => {

WebApplication/ClientApp/src/actions/uiFlagsActions.js

@@ -41,7 +41,8 @@ export const actionTypes = {
     CLEAR_CHECKED_PROJECTS: 'CLEAR_CHECKED_PROJECTS',
     SHOW_DRAWING_PROGRESS: 'SHOW_DRAWING_PROGRESS',
     SET_DRAWING_URL: 'SET_DRAWING_URL',
-    INVALIDATE_DRAWING: 'INVALIDATE_DRAWING'
+    INVALIDATE_DRAWING: 'INVALIDATE_DRAWING',
+    SET_STATS: 'SET_STATS'
 };
 
 export default actionTypes;
@@ -217,4 +218,11 @@ export const invalidateDrawing = () => {
     return {
         type: actionTypes.INVALIDATE_DRAWING
     };
-};
+};
+
+export const setStats = (stats) => {
+    return {
+        type: actionTypes.SET_STATS,
+        stats
+    };
+};

WebApplication/ClientApp/src/actions/uploadPackageActions.js

@@ -19,7 +19,7 @@
 import repo from '../Repository';
 import { uploadPackageData } from '../reducers/mainReducer';
 import { addProject } from './projectListActions';
-import { setProjectAlreadyExists, showUploadPackage } from './uiFlagsActions';
+import { setProjectAlreadyExists, showUploadPackage, setStats } from './uiFlagsActions';
 import { addError, addLog } from './notificationActions';
 import { Jobs } from '../JobManager';
 
@@ -64,9 +64,10 @@ export const uploadPackage = () => async (dispatch, getState) => {
                     dispatch(addLog('JobManager: HubConnection started for adopt project : ' + uploadResponse));
                 },
                 // onComplete
-                newProject => {
+                (newProject, stats) => {
                     dispatch(addLog('JobManager: Received onComplete'));
                     dispatch(addProject(newProject));
+                    dispatch(setStats(stats));
                     dispatch(setUploadProgressDone());
                 },
                 // onError

WebApplication/ClientApp/src/actions/uploadPackageActions.test.js

@@ -69,15 +69,18 @@ describe('uploadPackage', () => {
         expect(uploadPackageMock).toHaveBeenCalledTimes(1);
 
         const newProject = { name: "newProject" };
-        connectionMock.simulateComplete(newProject);
+        const theStats = { credits: 1 };
+        connectionMock.simulateComplete(newProject, theStats);
 
         const actions = store.getActions();
 
         // check expected actions and their types
         expect(actions[0].type).toEqual(uiFlagsActionTypes.SHOW_UPLOAD_PACKAGE);
         expect(actions[1].type).toEqual(actionTypes.SET_UPLOAD_PROGRESS_VISIBLE);
         // there are some logs in action in between...
-        expect(actions[actions.length-2].type).toEqual(projectListActions.ADD_PROJECT);
+        expect(actions[actions.length-3].type).toEqual(projectListActions.ADD_PROJECT);
+        expect(actions[actions.length-2].type).toEqual(uiFlagsActionTypes.SET_STATS);
+        expect(actions[actions.length-2].stats).toEqual(theStats);
         expect(actions[actions.length-1].type).toEqual(actionTypes.SET_UPLOAD_PROGRESS_DONE);
     });
 

WebApplication/ClientApp/src/components/creditCost.js

@@ -0,0 +1,62 @@
+/////////////////////////////////////////////////////////////////////
+// Copyright (c) Autodesk, Inc. All rights reserved
+// Written by Forge Design Automation team for Inventor
+//
+// Permission to use, copy, modify, and distribute this software in
+// object code form for any purpose and without fee is hereby granted,
+// provided that the above copyright notice appears in all copies and
+// that both that copyright notice and the limited warranty and
+// restricted rights notice below appear in all supporting
+// documentation.
+//
+// AUTODESK PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
+// AUTODESK SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
+// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  AUTODESK, INC.
+// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
+// UNINTERRUPTED OR ERROR FREE.
+/////////////////////////////////////////////////////////////////////
+
+import React, { Component } from 'react';
+import { connect } from 'react-redux';
+import Spacer from "@hig/spacer";
+import Typography from "@hig/typography";
+import { getStats } from '../reducers/mainReducer';
+import { Cloud16 } from '@hig/icons';
+import { significantDigits } from '../utils/conversion';
+
+export class CreditCost extends Component {
+    render() {
+
+        return (
+            <div>
+                {this.props.stats?.processing ?
+                    <div>
+                        <Typography><b>Consumed resources:</b></Typography>
+                        <Spacer spacing='s'/>
+                        <Typography>Download: {significantDigits(this.props.stats?.download, 5)}s</Typography>
+                        <Typography>Processing: {significantDigits(this.props.stats?.processing, 5)}s</Typography>
+                        <Typography>Upload: {significantDigits(this.props.stats?.upload, 5)}s</Typography>
+                        <Typography><b>Overall time: {significantDigits(this.props.stats?.total, 5)}s</b></Typography>
+                        <Typography><b>Cloud Credits: {significantDigits(this.props.stats?.credits, 5)}</b> <Cloud16/></Typography>
+                        <Spacer spacing='s'/>
+                        <Typography>Queuing: {significantDigits(this.props.stats?.queueing, 5)}s</Typography>
+                    </div>
+                    :
+                    <div>
+                    <Typography><b>Used cache, Cloud Credits: 0</b> <Cloud16/></Typography>
+                    <Spacer spacing='s'/>
+                    <Typography>The last consumed Cloud Credits: {significantDigits(this.props.stats?.credits, 5)} <Cloud16/></Typography>
+                    </div>
+                }
+                <Spacer spacing='m'/>
+            </div>
+        );
+    }
+}
+
+/* istanbul ignore next */
+export default connect(function (store){
+    return {
+      stats: getStats(store)
+    };
+})(CreditCost);