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

feat(ui): support any yaml reference in link #5667

Merged
merged 3 commits into from
Apr 14, 2021
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
4 changes: 2 additions & 2 deletions api/jsonschema/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -3814,11 +3814,11 @@
"type": "string"
},
"scope": {
"description": "Either \"workflow\" or \"pod\"",
"description": "\"workflow\", \"pod\", \"pod-logs\", \"event-source-logs\", \"sensor-logs\" or \"chat\"",
"type": "string"
},
"url": {
"description": "The URL. May contain \"${metadata.namespace}\", \"${metadata.name}\", \"${status.startedAt}\" and \"${status.finishedAt}\".",
"description": "The URL. Can contain \"${metadata.namespace}\", \"${metadata.name}\", \"${status.startedAt}\", \"${status.finishedAt}\" or any other element in workflow yaml, e.g. \"${io.argoproj.workflow.v1alpha1.metadata.annotations.userDefinedKey}\"",
"type": "string"
}
},
Expand Down
4 changes: 2 additions & 2 deletions api/openapi-spec/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -7234,11 +7234,11 @@
"type": "string"
},
"scope": {
"description": "Either \"workflow\" or \"pod\"",
"description": "\"workflow\", \"pod\", \"pod-logs\", \"event-source-logs\", \"sensor-logs\" or \"chat\"",
"type": "string"
},
"url": {
"description": "The URL. May contain \"${metadata.namespace}\", \"${metadata.name}\", \"${status.startedAt}\" and \"${status.finishedAt}\".",
"description": "The URL. Can contain \"${metadata.namespace}\", \"${metadata.name}\", \"${status.startedAt}\", \"${status.finishedAt}\" or any other element in workflow yaml, e.g. \"${io.argoproj.workflow.v1alpha1.metadata.annotations.userDefinedKey}\"",
"type": "string"
}
},
Expand Down
4 changes: 2 additions & 2 deletions pkg/apis/workflow/v1alpha1/generated.proto

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions pkg/apis/workflow/v1alpha1/info.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ package v1alpha1
type Link struct {
// The name of the link, E.g. "Workflow Logs" or "Pod Logs"
Name string `json:"name" protobuf:"bytes,1,opt,name=name"`
// Either "workflow" or "pod"
// "workflow", "pod", "pod-logs", "event-source-logs", "sensor-logs" or "chat"
Scope string `json:"scope" protobuf:"bytes,2,opt,name=scope"`
// The URL. May contain "${metadata.namespace}", "${metadata.name}", "${status.startedAt}" and "${status.finishedAt}".
// The URL. Can contain "${metadata.namespace}", "${metadata.name}", "${status.startedAt}", "${status.finishedAt}" or any other element in workflow yaml, e.g. "${workflow.metadata.annotations.userDefinedKey}"
URL string `json:"url" protobuf:"bytes,3,opt,name=url"`
}
4 changes: 2 additions & 2 deletions pkg/apis/workflow/v1alpha1/openapi_generated.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {execSpec, Link, Workflow} from '../../../../models';
import {uiUrl} from '../../../shared/base';
import {BasePage} from '../../../shared/components/base-page';
import {ErrorNotice} from '../../../shared/components/error-notice';
import {ProcessURL} from '../../../shared/components/links';
import {Loading} from '../../../shared/components/loading';
import {ResourceEditor} from '../../../shared/components/resource-editor/resource-editor';
import {services} from '../../../shared/services';
Expand Down Expand Up @@ -261,10 +262,17 @@ export class ArchivedWorkflowDetails extends BasePage<RouteComponentProps<any>,
}

private openLink(link: Link) {
document.location.href = link.url
.replace(/\${metadata\.namespace}/g, this.state.workflow.metadata.namespace)
.replace(/\${metadata\.name}/g, this.state.workflow.metadata.name)
.replace(/\${status\.startedAt}/g, this.state.workflow.status.startedAt)
.replace(/\${status\.finishedAt}/g, this.state.workflow.status.finishedAt);
const object = {
metadata: {
namespace: this.state.workflow.metadata.namespace,
name: this.state.workflow.metadata.name
},
workflow: this.state.workflow,
status: {
startedAt: this.state.workflow.status.startedAt,
finishedAt: this.state.workflow.status.finishedAt
}
};
document.location.href = ProcessURL(link.url, object);
}
}
23 changes: 15 additions & 8 deletions ui/src/app/shared/components/links.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
import {ObjectMeta} from 'argo-ui/src/models/kubernetes';
import {useEffect, useState} from 'react';
import React = require('react');
import {Link} from '../../../models';
import {Link, Workflow} from '../../../models';
import {services} from '../services';
import {Button} from './button';

export const Links = ({scope, object, button}: {scope: string; object: {metadata: ObjectMeta; status?: any}; button?: boolean}) => {
export const ProcessURL = (url: string, jsonObject: any) => {
/* replace ${} from input url with corresponding elements from object
return null if element is not found*/
return url.replace(/\${[^}]*}/g, x => {
tczhao marked this conversation as resolved.
Show resolved Hide resolved
const res = x
.replace(/[${}]+/g, '')
.split('.')
.reduce((p: any, c: string) => (p && p[c]) || null, jsonObject);
return res;
});
};

export const Links = ({scope, object, button}: {scope: string; object: {metadata: ObjectMeta; workflow?: Workflow; status?: any}; button?: boolean}) => {
const [links, setLinks] = useState<Link[]>();
const [error, setError] = useState<Error>();

Expand All @@ -18,12 +30,7 @@ export const Links = ({scope, object, button}: {scope: string; object: {metadata
}, []);

const formatUrl = (url: string) => {
const status = object.status || {};
return url
.replace(/\${metadata\.namespace}/g, object.metadata.namespace)
.replace(/\${metadata\.name}/g, object.metadata.name)
.replace(/\${status\.startedAt}/g, status.startedAt)
.replace(/\${status\.finishedAt}/g, status.finishedAt);
return ProcessURL(url, object);
};

const openLink = (url: string) => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {execSpec, Link, Workflow} from '../../../../models';
import {uiUrl} from '../../../shared/base';
import {CostOptimisationNudge} from '../../../shared/components/cost-optimisation-nudge';
import {ErrorNotice} from '../../../shared/components/error-notice';
import {ProcessURL} from '../../../shared/components/links';
import {Loading} from '../../../shared/components/loading';
import {SecurityNudge} from '../../../shared/components/security-nudge';
import {hasWarningConditionBadge} from '../../../shared/conditions-panel';
Expand Down Expand Up @@ -201,11 +202,19 @@ export const WorkflowDetails = ({history, location, match}: RouteComponentProps<
}, [namespace, name]);

const openLink = (link: Link) => {
const url = link.url
.replace(/\${metadata\.namespace}/g, workflow.metadata.namespace)
.replace(/\${metadata\.name}/g, workflow.metadata.name)
.replace(/\${status\.startedAt}/g, workflow.status.startedAt)
.replace(/\${status\.finishedAt}/g, workflow.status.finishedAt);
const object = {
metadata: {
namespace: workflow.metadata.namespace,
name: workflow.metadata.name
},
workflow,
status: {
startedAt: workflow.status.startedAt,
finishedAt: workflow.status.finishedAt
}
};
const url = ProcessURL(link.url, object);

if ((window.event as MouseEvent).ctrlKey) {
window.open(url, '_blank');
} else {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ export const WorkflowLogsViewer = ({workflow, nodeId, container, archived}: Work
namespace: workflow.metadata.namespace,
name: podName
},
workflow,
status: {
startedAt: workflow.status.startedAt,
finishedAt: workflow.status.finishedAt
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ const WorkflowNodeSummary = (props: Props) => {
namespace: props.workflow.metadata.namespace,
name: props.node.id
},
workflow: props.workflow,
status: {
startedAt: props.node.startedAt,
finishedAt: props.node.finishedAt
Expand Down