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

Joyride tutorials update #679

Merged
merged 4 commits into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion backend/metagrid/api_proxy/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ def do_request(request, urlbase):
resp = requests.get(urlbase)

# print(resp.text)
httpresp = HttpResponse(resp.text)
httpresp = HttpResponse(resp.text, content_type="text/json")
httpresp.status_code = resp.status_code

return httpresp
Expand Down
2 changes: 1 addition & 1 deletion frontend/.envs/.react
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ REACT_APP_AUTHENTICATION_METHOD=globus
# Globus
# ------------------------------------------------------------------------------
REACT_APP_GLOBUS_REDIRECT=http://localhost:3000/cart/items
REACT_APP_CLIENT_ID=7fa7ac4a-a051-4b26-836f-b292b5c5b268
REACT_APP_CLIENT_ID=8286db4d-269e-4c68-88a1-2af9a20f7f09
REACT_APP_GLOBUS_NODES=aims3.llnl.gov,esgf-data1.llnl.gov,esgf-data2.llnl.gov

# ------------------------------------------------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions frontend/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "frontend",
"version": "1.2.0",
"version": "1.2.1",
"private": true,
"scripts": {
"build:local": "env-cmd -f .envs/.react react-scripts build",
Expand Down Expand Up @@ -59,7 +59,7 @@
}
},
"moduleNameMapper": {
"react-markdown": "<rootDir>/node_modules/react-markdown/react-markdown.min.js"
"react-markdown": "<rootDir>/src/test/__mocks__/ReactMarkdownMock.tsx"
}
},
"dependencies": {
Expand All @@ -83,7 +83,7 @@
"react-dom": "18.2.0",
"react-hotjar": "2.2.1",
"react-joyride": "2.5.3",
"react-markdown": "8.0.7",
"react-markdown": "9.0.1",
"react-router-dom": "^6.9.0",
"react-scripts": "5.0.1",
"recoil": "0.7.7",
Expand Down
4 changes: 4 additions & 0 deletions frontend/public/changelog/v1.2.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## Summary

1. Updates to the tutorials: added new tutorial for the Globus transfer feature.
2. Minor bugfixes.
2 changes: 1 addition & 1 deletion frontend/src/common/TargetObject.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ describe('Test TourTarget class', () => {
createTestTour('testGroup', {});
});

it('Successfully creates joyride tour fron test targets', () => {
it('Successfully creates joyride tour from test targets', () => {
const testTargets = {
test1: new TargetObject('test1'),
test2: new TargetObject('test2'),
Expand Down
81 changes: 74 additions & 7 deletions frontend/src/common/reactJoyrideSteps.ts
Original file line number Diff line number Diff line change
Expand Up @@ -157,9 +157,21 @@ export const cartTourTargets = {
libraryBtn: new TargetObject(),
downloadAllType: new TargetObject(),
downloadAllBtn: new TargetObject(),
globusCollectionDropdown: new TargetObject(),
removeItemsBtn: new TargetObject(),
};

export const manageCollectionsTourTargets = {
globusCollectionsForm: new TargetObject(),
searchCollectionInput: new TargetObject(),
globusSearchResultsPanel: new TargetObject(),
globusSearchResults: new TargetObject(),
mySavedCollectionsPanel: new TargetObject(),
mySavedCollections: new TargetObject(),
saveCollectionBtn: new TargetObject(),
cancelCollectionBtn: new TargetObject(),
};

export const savedSearchTourTargets = {
savedSearches: new TargetObject(),
projectDescription: new TargetObject(),
Expand All @@ -181,6 +193,7 @@ export const nodeTourTargets = {
export enum TourTitles {
Main = 'Main Search Page Tour',
Cart = 'Data Cart Tour',
ManageCollections = 'Manage My Collections Tour',
Searches = 'Saved Searches Tour',
Node = 'Node Status Tour',
Welcome = 'Welcome Tour',
Expand Down Expand Up @@ -713,14 +726,29 @@ export const createCartItemsTour = (
await delay(300);
}
)
.addNextStep(
cartTourTargets.removeItemsBtn.selector(),
'We can remove all items from the cart with this button.',
'right-start'
)
.addNextStep(
cartTourTargets.downloadAllType.selector(),
'This will select which download script to use (only wget is available currently).',
'This will select which download method to use. The Globus download method is the default.',
'top-start',
/* istanbul ignore next */
async () => {
clickFirstElement(cartTourTargets.downloadAllType.selector());
await delay(500);
}
)
.addNextStep(
cartTourTargets.globusCollectionDropdown.selector(),
"For Globus downloads, you need to select a saved collection from this drop-down. If you haven't saved any collections, you can do so by clicking the 'Manage Collections' option.",
'top-start'
)
.addNextStep(
cartTourTargets.downloadAllBtn.selector(),
'Then you would click this button to get the download script needed for all currently selected datasets in the cart.',
'After selecting your collection, click this button to start the download for your selected cart items.',
'top-start',
/* istanbul ignore next */
async () => {
Expand All @@ -730,11 +758,6 @@ export const createCartItemsTour = (
await delay(300);
}
)
.addNextStep(
cartTourTargets.removeItemsBtn.selector(),
'We can remove all items from the cart with this button.',
'right-start'
)
.addNextStep('body', 'This concludes the cart page tour.', 'center')
.setOnFinish(
/* istanbul ignore next */
Expand All @@ -758,6 +781,50 @@ export const createCartItemsTour = (
return tour;
};

export const createCollectionsFormTour = (): JoyrideTour => {
const tour = new JoyrideTour(TourTitles.ManageCollections)
.addNextStep(
manageCollectionsTourTargets.globusCollectionsForm.selector(),
"The 'Manage My Collections' form allows you to search for and save Globus collections which you can then select to perform Globus transfers."
)
.addNextStep(
manageCollectionsTourTargets.searchCollectionInput.selector(),
"First, type your search text in here, then press 'Enter' or click the blue search button to the right."
)
.addNextStep(
manageCollectionsTourTargets.globusSearchResults.selector(),
"The search results will be displayed in this table, where you can click 'Add' for the collections you wish to save.",
'auto',
/* istanbul ignore next */
async () => {
clickFirstElement(
manageCollectionsTourTargets.mySavedCollectionsPanel.selector()
);
await delay(500);
}
)
.addNextStep(
manageCollectionsTourTargets.mySavedCollections.selector(),
"Your currently saved collections are displayed in this table, where you can also 'Set' or 'Update' the file path to use for a specific collection. If the path is set for a specific collection, you won't have to set the path again when doing transfers to that collection.",
'auto'
)
.addNextStep('body', 'This concludes the cart page tour.', 'center')
.setOnFinish(
/* istanbul ignore next */
() => {
// Clean-up step for when the tour is complete (or skipped)
return async () => {
clickFirstElement(
manageCollectionsTourTargets.mySavedCollectionsPanel.selector()
);
await delay(300);
};
}
);

return tour;
};

export const createSearchCardTour = (
setCurrentPage: (page: number) => void
): JoyrideTour => {
Expand Down
62 changes: 57 additions & 5 deletions frontend/src/components/Globus/DatasetDownload.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { DownloadOutlined } from '@ant-design/icons';
import { DownloadOutlined, QuestionOutlined } from '@ant-design/icons';
import {
Button,
Card,
Expand All @@ -25,7 +25,11 @@ import {
REQUESTED_SCOPES,
createGlobusAuthObject,
} from '../../api';
import { cartTourTargets } from '../../common/reactJoyrideSteps';
import {
cartTourTargets,
createCollectionsFormTour,
manageCollectionsTourTargets,
} from '../../common/reactJoyrideSteps';
import { globusEnabledNodes, globusRedirectUrl } from '../../env';
import { RawSearchResults } from '../Search/types';
import CartStateKeys, {
Expand All @@ -42,6 +46,10 @@ import {
} from './types';
import { NotificationType, showError, showNotice } from '../../common/utils';
import { DataPersister } from '../../common/DataPersister';
import {
RawTourState,
ReactJoyrideContext,
} from '../../contexts/ReactJoyrideContext';

type AlertModalState = {
onCancelAction: () => void;
Expand All @@ -67,6 +75,10 @@ const dp: DataPersister = DataPersister.Instance;
const DatasetDownloadForm: React.FC<React.PropsWithChildren<unknown>> = () => {
const [messageApi, contextHolder] = message.useMessage();

// Tutorial state
const tourState: RawTourState = React.useContext(ReactJoyrideContext);
const { startSpecificTour } = tourState;

const [downloadIsLoading, setDownloadIsLoading] = useRecoilState<boolean>(
cartDownloadIsLoading
);
Expand Down Expand Up @@ -904,6 +916,7 @@ const DatasetDownloadForm: React.FC<React.PropsWithChildren<unknown>> = () => {
/>
{selectedDownloadType === 'Globus' && (
<Select
className={cartTourTargets.globusCollectionDropdown.class()}
data-testid="searchCollectionInput"
defaultActiveFirstOption={false}
filterOption={false}
Expand Down Expand Up @@ -989,10 +1002,31 @@ const DatasetDownloadForm: React.FC<React.PropsWithChildren<unknown>> = () => {
</Button>
</Space>
<Modal
className={manageCollectionsTourTargets.globusCollectionsForm.class()}
data-testid="manageCollectionsForm"
title="Manage My Collections"
title={
<>
Manage My Collections{' '}
<Button
shape="circle"
type="primary"
icon={
<QuestionOutlined
color="primary"
style={{ fontSize: '20px' }}
/>
}
onClick={() => {
startSpecificTour(createCollectionsFormTour());
}}
></Button>
</>
}
open={endpointSearchOpen}
okText="Save"
okButtonProps={{
className: manageCollectionsTourTargets.saveCollectionBtn.class(),
}}
onOk={async () => {
setEndpointSearchOpen(false);
await dp.setValue(
Expand All @@ -1007,6 +1041,9 @@ const DatasetDownloadForm: React.FC<React.PropsWithChildren<unknown>> = () => {
);
}}
cancelText="Cancel Changes"
cancelButtonProps={{
className: manageCollectionsTourTargets.cancelCollectionBtn.class(),
}}
onCancel={async () => {
setEndpointSearchOpen(false);
await dp.setValue(
Expand All @@ -1019,6 +1056,7 @@ const DatasetDownloadForm: React.FC<React.PropsWithChildren<unknown>> = () => {
width={1000}
>
<Input.Search
className={manageCollectionsTourTargets.searchCollectionInput.class()}
value={endpointSearchValue}
onChange={(e) => {
setEndpointSearchValue(e.target.value);
Expand All @@ -1034,9 +1072,16 @@ const DatasetDownloadForm: React.FC<React.PropsWithChildren<unknown>> = () => {
items={[
{
key: '1',
label: 'Globus Collection Search Results',
label: (
<div
className={manageCollectionsTourTargets.globusSearchResultsPanel.class()}
>
Globus Collection Search Results
</div>
),
children: (
<Table
className={manageCollectionsTourTargets.globusSearchResults.class()}
data-testid="globusEndpointSearchResults"
loading={loadingEndpointSearchResults}
size="small"
Expand Down Expand Up @@ -1102,9 +1147,16 @@ const DatasetDownloadForm: React.FC<React.PropsWithChildren<unknown>> = () => {
},
{
key: '2',
label: 'My Saved Globus Collections',
label: (
<div
className={manageCollectionsTourTargets.mySavedCollectionsPanel.class()}
>
My Saved Globus Collections
</div>
),
children: (
<Table
className={manageCollectionsTourTargets.mySavedCollections.class()}
data-testid="savedGlobusEndpoints"
size="small"
pagination={
Expand Down
4 changes: 2 additions & 2 deletions frontend/src/components/Messaging/MessageCard.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React, { useEffect } from 'react';
import ReactMarkdown from 'react-markdown';
import Markdown from 'react-markdown';
import { MarkdownMessage } from './types';

const MessageCard: React.FC<React.PropsWithChildren<MarkdownMessage>> = ({
Expand All @@ -18,7 +18,7 @@ const MessageCard: React.FC<React.PropsWithChildren<MarkdownMessage>> = ({
});
}, []);

return <ReactMarkdown>{content}</ReactMarkdown>;
return <Markdown>{content}</Markdown>;
};

export default MessageCard;
2 changes: 2 additions & 0 deletions frontend/src/components/Messaging/Templates/Welcome.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// eslint-disable @typescript-eslint/no-unsafe-argument

import { Button, Card, Col, Row } from 'antd';
import React from 'react';
import { useNavigate } from 'react-router-dom';
Expand Down
12 changes: 11 additions & 1 deletion frontend/src/components/Messaging/messageDisplayData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export const rightDrawerMessages: MarkdownMessage[] = [
];

export const rightDrawerChanges: MarkdownMessage[] = [
{ title: 'V1.2.1', fileName: 'changelog/v1.2.1.md' },
{ title: 'V1.2.0', fileName: 'changelog/v1.2.0.md' },
{ title: 'V1.1.3-pre', fileName: 'changelog/v1.1.3-pre.md' },
{ title: 'V1.1.2-pre', fileName: 'changelog/v1.1.2-pre.md' },
Expand All @@ -16,9 +17,18 @@ export const rightDrawerChanges: MarkdownMessage[] = [
];

const startupMessages: StartPopupData = {
messageToShow: 'v1.2.0', // This is the version number that appears in the footer
messageToShow: 'v1.2.1', // This is the version number that appears in the footer
defaultMessageId: 'welcome',
messageData: [
{
messageId: 'v1.2.1',
template: MessageTemplates.ChangeLog,
style: { minWidth: '700px' },
data: {
changesFile: 'changelog/v1.2.1.md',
version: '1.2.1',
},
},
{
messageId: 'v1.2.0',
template: MessageTemplates.ChangeLog,
Expand Down
Loading
Loading