-
Notifications
You must be signed in to change notification settings - Fork 50
/
client.ts
246 lines (210 loc) · 6.81 KB
/
client.ts
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
/*
* Copyright 2020 Google LLC
*
* 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 path from 'path';
import { Storage, StorageOptions, PredefinedAcl } from '@google-cloud/storage';
import {
randomFilepath,
inParallel,
toPlatformPath,
toPosixPath,
} from '@google-github-actions/actions-utils';
import { Metadata } from './headers';
import { deepClone } from './util';
// Do not listen to the linter - this can NOT be rewritten as an ES6 import statement.
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { version: appVersion } = require('../package.json');
// userAgent is the default user agent.
const userAgent = `google-github-actions:upload-cloud-storage/${appVersion}`;
/**
* Available options to create the client.
*
* @param projectID GCP Project ID.
*/
export type ClientOptions = {
projectID?: string;
};
/**
* ClientFileUpload represents a file to upload. It keeps track of the local
* source path and remote destination.
*/
export type ClientFileUpload = {
/**
* source is the absolute, local path on disk to the file.
*/
source: string;
/**
* destination is the remote location for the file, relative to the bucket
* root.
*/
destination: string;
};
/**
* ClientUploadOptions is the list of available options during file upload.
*/
export interface ClientUploadOptions {
/**
* bucket is the name of the bucket in which to upload.
*/
bucket: string;
/**
* files is the list of absolute file paths on local disk to upload. This list
* must use posix path separators for files.
*/
files: ClientFileUpload[];
/**
* concurrency is the maximum number of parallel upload operations that will
* take place.
*/
concurrency?: number;
/**
* metadata is object metadata to set. These are usually populated from
* headers.
*/
metadata?: Metadata;
/**
* gzip indicates whether to gzip the object when uploading.
*/
gzip?: boolean;
/**
* resumable indicates whether the upload should be resumable after interrupt.
*/
resumable?: boolean;
/**
* predefinedAcl defines the default ACL to apply to new objects.
*/
predefinedAcl?: PredefinedAcl;
/**
* onUploadObject is called each time an object upload begins.
**/
onUploadObject?: FOnUploadObject;
}
/**
* FOnUploadObject is the function interface for the upload callback signature.
*/
export interface FOnUploadObject {
(source: string, destination: string, opts: Record<string, unknown>): void;
}
/**
* ClientComputeDestinationOptions is the list of options to compute file
* destinations in a target bucket.
*/
export interface ClientComputeDestinationOptions {
/**
* givenRoot is the root given by the input to the function.
*/
givenRoot: string;
/**
* absoluteRoot is the absolute root path, used for resolving the files.
*/
absoluteRoot: string;
/**
* files is a list of filenames, for a glob expansion. All files are relative
* to absoluteRoot.
*/
files: string[];
/**
* prefix is an optional prefix to predicate on all paths.
*/
prefix?: string;
/**
* includeParent indicates whether the local directory parent name (dirname of
* givenRoot) should be included in the destination path in the bucket.
*/
includeParent?: boolean;
}
/**
* Handles credential lookup, registration and wraps interactions with the GCS
* Helper.
*
* @param opts List of ClientOptions.
*/
export class Client {
readonly storage: Storage;
constructor(opts?: ClientOptions) {
const options: StorageOptions = {
projectId: opts?.projectID,
userAgent: userAgent,
};
this.storage = new Storage(options);
}
/**
* computeDestinations builds a collection of files to their intended upload
* paths in a Cloud Storage bucket, based on the given options.
*
* @param opts List of inputs and files to compute.
* @return List of files to upload with the source as a local file path and
* the remote destination path.
*/
static computeDestinations(opts: ClientComputeDestinationOptions): ClientFileUpload[] {
const list: ClientFileUpload[] = [];
for (let i = 0; i < opts.files.length; i++) {
const name = opts.files[i];
// Calculate destination by joining the prefix (if one exists), the parent
// directory name (if includeParent is true), and the file name. path.join
// ignores empty strings. We only want to do this if
const base = opts.includeParent ? path.posix.basename(toPosixPath(opts.givenRoot)) : '';
const destination = path.posix.join(opts.prefix || '', base, name);
// Compute the absolute path of the file.
const source = path.resolve(opts.absoluteRoot, toPlatformPath(name));
list.push({
source: source,
destination: destination,
});
}
return list;
}
/**
* upload puts the given collection of files into the bucket. It will
* overwrite any existing objects with the same name and create any new
* objects. It does not delete any existing objects.
*
* @param opts ClientUploadOptions
*
* @return The list of files uploaded.
*/
async upload(opts: ClientUploadOptions): Promise<string[]> {
const bucket = opts.bucket;
const storageBucket = this.storage.bucket(bucket);
const uploadOne = async (file: ClientFileUpload): Promise<string> => {
const source = file.source;
const destination = file.destination;
// Apparently the Cloud Storage SDK modifies this object, so we need to
// make our own deep copy before passing it to upload. See #258 for more
// information.
const uploadOpts = deepClone({
destination: destination,
metadata: opts.metadata || {},
gzip: opts.gzip,
predefinedAcl: opts.predefinedAcl,
resumable: opts.resumable,
configPath: randomFilepath(),
});
// Execute callback if defined
if (opts.onUploadObject) {
opts.onUploadObject(source, path.posix.join(bucket, destination), uploadOpts);
}
// Do the upload
const response = await storageBucket.upload(source, uploadOpts);
const name = response[0].name;
return name;
};
const args: [file: ClientFileUpload][] = opts.files.map((file) => [file]);
const results = await inParallel(uploadOne, args, {
concurrency: opts.concurrency,
});
return results;
}
}