-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
MinioArtifactPreview.tsx
168 lines (156 loc) · 5.1 KB
/
MinioArtifactPreview.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/**
* Copyright 2021 The Kubeflow Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import * as React from 'react';
import { stylesheet } from 'typestyle';
import { color } from '../Css';
import { StorageService, StoragePath } from '../lib/WorkflowParser';
import { S3Artifact } from '../../third_party/argo-ui/argo_template';
import { isS3Endpoint } from '../lib/AwsHelper';
import { Apis } from '../lib/Apis';
import { ExternalLink } from '../atoms/ExternalLink';
import { ValueComponentProps } from './DetailsTable';
const css = stylesheet({
root: {
width: '100%',
},
preview: {
maxHeight: 250,
overflowY: 'auto',
padding: 3,
backgroundColor: color.lightGrey,
},
topDiv: {
display: 'flex',
justifyContent: 'space-between',
},
separater: {
width: 20, // There's minimum 20px separation between URI and view button.
display: 'inline-block',
},
viewLink: {
whiteSpace: 'nowrap',
},
});
/**
* Check if a javascript object is an argo S3Artifact object.
* @param value Any javascript object.
*/
export function isS3Artifact(value: any): value is S3Artifact {
return value && value.key && value.bucket;
}
export interface MinioArtifactPreviewProps extends ValueComponentProps<Partial<S3Artifact>> {
namespace?: string;
maxbytes?: number;
maxlines?: number;
}
function getStoragePath(value?: string | Partial<S3Artifact>) {
if (!value || typeof value === 'string') return;
const { key, bucket, endpoint } = value;
if (!bucket || !key) return;
const source = isS3Endpoint(endpoint) ? StorageService.S3 : StorageService.MINIO;
return { source, bucket, key };
}
async function getPreview(
storagePath: StoragePath,
namespace: string | undefined,
maxbytes: number,
maxlines?: number,
): Promise<{ data: string; hasMore: boolean }> {
// TODO how to handle binary data (can probably use magic number to id common mime types)
let data = await Apis.readFile(storagePath, namespace, maxbytes + 1);
// is preview === data and no maxlines
if (data.length <= maxbytes && !maxlines) {
return { data, hasMore: false };
}
// remove extra byte at the end (we requested maxbytes +1)
data = data.slice(0, maxbytes);
// check num lines
if (maxlines) {
data = data
.split('\n')
.slice(0, maxlines)
.join('\n')
.trim();
}
return { data: `${data}\n...`, hasMore: true };
}
/**
* A component that renders a preview to an artifact with a link to the full content.
*/
const MinioArtifactPreview: React.FC<MinioArtifactPreviewProps> = ({
value,
namespace,
maxbytes = 255,
maxlines,
}) => {
const [content, setContent] = React.useState<{ data: string; hasMore: boolean } | undefined>(
undefined,
);
const storagePath = getStoragePath(value);
const source = storagePath?.source;
const bucket = storagePath?.bucket;
const key = storagePath?.key;
React.useEffect(() => {
let cancelled = false;
if (source && bucket && key) {
getPreview({ source, bucket, key }, namespace, maxbytes, maxlines).then(
content => !cancelled && setContent(content),
error => console.error(error), // TODO error badge on link?
);
}
return () => {
cancelled = true;
};
}, [source, bucket, key, namespace, maxbytes, maxlines]);
if (!storagePath) {
// if value is undefined, null, or an invalid s3artifact object, don't render
if (value === null || value === undefined || typeof value === 'object') return null;
// otherwise render value as string (with default string method)
return <React.Fragment>{`${value}`}</React.Fragment>;
}
// TODO need to come to an agreement how to encode artifact info inside a url
// namespace is currently not supported
const linkText = Apis.buildArtifactUrl(storagePath);
const artifactDownloadUrl = Apis.buildReadFileUrl({
path: storagePath,
namespace,
isDownload: true,
});
const artifactViewUrl = Apis.buildReadFileUrl({ path: storagePath, namespace });
// Opens in new window safely
// TODO use ArtifactLink instead (but it need to support namespace)
return (
<div className={css.root}>
<div className={css.topDiv}>
<ExternalLink href={artifactDownloadUrl} title={linkText}>
{linkText}
</ExternalLink>
<span className={css.separater}></span>
<ExternalLink href={artifactViewUrl} className={css.viewLink}>
View All
</ExternalLink>
</div>
{content?.data && (
<div className={css.preview}>
<small>
<pre>{content.data}</pre>
</small>
</div>
)}
</div>
);
};
export default MinioArtifactPreview;