Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[OGUI-1608] Refactor to update FrameworkInfo to AboutView #2742

Merged
merged 3 commits into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions QualityControl/public/Model.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ import Layout from './layout/Layout.js';
import QCObject from './object/QCObject.js';
import LayoutService from './services/Layout.service.js';
import Folder from './folder/Folder.js';
import FrameworkInfo from './frameworkInfo/FrameworkInfo.js';
import QCObjectService from './services/QCObject.service.js';
import ObjectViewModel from './pages/objectView/ObjectViewModel.js';
import { setBrowserTabTitle } from './common/utils.js';
import { buildQueryParametersString } from './common/buildQueryParametersString.js';
import AboutViewModel from './pages/aboutView/AboutViewModel.js';

/**
* Represents the application's state and actions as a class
Expand Down Expand Up @@ -63,8 +63,8 @@ export default class Model extends Observable {
this.notification = new Notification(this);
this.notification.bubbleTo(this);

this.frameworkInfo = new FrameworkInfo(this);
this.frameworkInfo.bubbleTo(this);
this.aboutViewModel = new AboutViewModel(this);
this.aboutViewModel.bubbleTo(this);

this.isOnlineModeConnectionAlive = false;
this.isOnlineModeEnabled = false; // Show only online objects or all (offline)
Expand Down Expand Up @@ -261,7 +261,7 @@ export default class Model extends Observable {
case 'about':
this.page = 'about';
setBrowserTabTitle('QCG-About');
this.frameworkInfo.getFrameworkInfo();
this.aboutViewModel.getAboutViewModel();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @mariscalromeroalejandro. What is the reason for renaming this method to suggest that a model is retrieved?

this.notify();
break;
default:
Expand Down
4 changes: 2 additions & 2 deletions QualityControl/public/common/header.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { spinner } from './spinner.js';
import layoutViewHeader from '../layout/view/header.js';
import layoutListHeader from '../layout/list/header.js';
import objectTreeHeader from '../object/objectTreeHeader.js';
import frameworkInfoHeader from '../frameworkInfo/frameworkInfoHeader.js';
import aboutViewHeader from '../pages/aboutView/components/aboutViewHeader.js';

/**
* Shows header of the application, split with 3 parts:
Expand Down Expand Up @@ -46,7 +46,7 @@ const headerSpecific = (model) => {
case 'layoutList': return layoutListHeader(model);
case 'layoutShow': return layoutViewHeader(model);
case 'objectTree': return objectTreeHeader(model);
case 'about': return frameworkInfoHeader();
case 'about': return aboutViewHeader();
default: return null;
}
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
import { Observable, RemoteData } from '/js/src/index.js';

/**
* Model representing FrameworkInfo
* Model representing About View
*/
export default class FrameworkInfo extends Observable {
export default class AboutViewModel extends Observable {
/**
* Initialize `item` to NotAsked
* @param {Model} model - root model of the application
Expand All @@ -30,10 +30,10 @@ export default class FrameworkInfo extends Observable {
}

/**
* Load FrameworkInfo into `item`
* Load About Model into `item`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The model is the class itself.
This method does not Load About Model into item``.
In item, data about the server of the GUI and associated services is stored in a remotedata. A remote data is used so that a nice UX is provided to the User, to know when items are loading, failed, or successfully loaded.

* @returns {undefined}
*/
async getFrameworkInfo() {
async getAboutViewModel() {
this.item = RemoteData.loading();
this.notify();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import { h } from '/js/src/index.js';
*/
export default (model) => h(
'.p2.absolute-fill.text-center',
model.frameworkInfo.item.match({
model.aboutViewModel.item.match({
NotAsked: () => null,
Loading: () => null,
Success: (data) => showContent(data),
Expand Down
4 changes: 2 additions & 2 deletions QualityControl/public/view.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import layoutEditModal from './layout/panels/editModal.js';

import objectTreePage from './object/objectTreePage.js';
import ObjectViewPage from './pages/objectView/ObjectViewPage.js';
import frameworkInfoPage from './frameworkInfo/frameworkInfoPage.js';
import AboutViewPage from './pages/aboutView/AboutViewPage.js';

/**
* Entry point to generate view of QCG as a tree of function calls
Expand Down Expand Up @@ -56,7 +56,7 @@ function page(model) {
case 'layoutShow': return layoutViewPage(model);
case 'objectTree': return objectTreePage(model);
case 'objectView': return ObjectViewPage(model);
case 'about': return frameworkInfoPage(model);
case 'about': return AboutViewPage(model);

// Should be seen only at the first start when the view is not yet really to be shown (data loading)
default: return null;
Expand Down
12 changes: 8 additions & 4 deletions QualityControl/test/public/pages/about-page.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
* granted to it by virtue of its status as an Intergovernmental Organization
* or submit itself to any jurisdiction.
*/
/* eslint-disable max-len */

import { strictEqual, deepStrictEqual } from 'assert';
import test from '../index';
Expand All @@ -27,14 +26,19 @@ describe('about page test suite', async () => {
strictEqual(location.search, '?page=about');
});

it('should have a frameworkInfo item with config fields', async () => {
it('should have an About View Model item with config fields', async () => {
const expConfig = {
qcg: { port: 8181, hostname: 'localhost', status: { ok: true } },
consul: { hostname: 'localhost', port: 8500, status: { ok: false, message: 'Live Mode was not configured' } },
ccdb: { hostname: 'ccdb', port: 8500, prefix: 'test', status: { ok: false, message: 'Data connector was not configured' } },
ccdb: {
hostname: 'ccdb',
port: 8500,
prefix: 'test',
status: { ok: false, message: 'Data connector was not configured' },
},
quality_control: { version: '0.19.5-1' },
};
const config = await page.evaluate(() => window.model.frameworkInfo.item);
const config = await page.evaluate(() => window.model.aboutViewModel.item);
delete config.payload.qcg.version;
deepStrictEqual(config.payload, expConfig);
});
Expand Down