This repository has been archived by the owner on May 22, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
blobs.ts
279 lines (251 loc) · 8.95 KB
/
blobs.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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
// This file is part of the @egomobile/azure-storage distribution.
// Copyright (c) Next.e.GO Mobile SE, Aachen, Germany (https://e-go-mobile.com/)
//
// @egomobile/azure-storage is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, version 3.
//
// @egomobile/azure-storage is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
import { BlobServiceClient, ContainerClient } from '@azure/storage-blob';
import type { Nilable } from './types';
/**
* Provides a blob service client by name.
*
* @param {string} name The connection name.
*
* @returns {BlobServiceClient} The client.
*/
export type BlobServiceClientProvider = (name: string) => BlobServiceClient;
/**
* Provides a container service client by name.
*
* @param {string} name Theconnection name.
* @param {Nilable<string>} [container] The custom container name.
*
* @returns {ContainerClient} The client.
*/
export type ContainerClientProvider = (name: string, container?: Nilable<string>) => ContainerClient;
/**
* A function, that returns the options for getting a blob storage client by name.
*
* @param {string} name The connection name.
*
* @returns {IBlobStorageClientOptions} The options.
*/
export type GetBlobStorageClientOptions = (name: string) => IBlobStorageClientOptions;
/**
* A function, that returns the options for getting a container client by name.
*
* @param {string} name The connection name.
* @param {Nilable<string>} [container] The custom container name.
*
* @returns {IBlobStorageClientOptions} The options.
*/
export type GetContainerClientOptions = (name: string, container?: Nilable<string>) => IContainerClientOptions;
/**
* Options for a blob storage client.
*/
export interface IBlobStorageClientOptions {
/**
* The connection URL.
*/
url: string;
}
/**
* Options for a conatiner client.
*/
export interface IContainerClientOptions extends IBlobStorageClientOptions {
/**
* The container name.
*/
container: string;
}
/**
* Default function, that returns the options for getting a blob storage client by name.
*
* The variables must have the following structure:
*
* - AZURE_STORAGE_CONNECTION_{NR} => the name of the connection
* - AZURE_STORAGE_CONNECTION_{NR}_URL => the connection URL
*
* @param {string} name The connection name.
*
* @returns {IBlobStorageClientOptions} The options.
*/
export const defaultGetBlobStorageClientOptions: GetBlobStorageClientOptions = (name): IBlobStorageClientOptions => {
const connectionNr = getAzureStorageConnectionNrFromEnvVar(name);
const url = process.env[`AZURE_STORAGE_CONNECTION_${connectionNr}_URL`]?.trim();
if (!url?.length) {
throw new Error(`Azure storage connection ${name} not found`);
}
return {
url
};
};
/**
* Default function, that returns the options for getting a container client by name.
*
* The variables must have the following structure:
*
* - AZURE_STORAGE_CONNECTION_{NR} => the name of the connection
* - AZURE_STORAGE_CONNECTION_{NR}_CONTAINER => the default container name
* - AZURE_STORAGE_CONNECTION_{NR}_URL => the connection URL
*
* @param {string} name The connection name.
* @param {Nilable<string>} [container] The custom container name.
*
* @returns {IContainerClientOptions} The options.
*/
export const defaultGetContainerClientOptions: GetContainerClientOptions = (name, container?): IContainerClientOptions => {
const connectionNr = getAzureStorageConnectionNrFromEnvVar(name);
const storageOpts = defaultGetBlobStorageClientOptions(name);
container = container?.trim();
if (!container?.length) {
container = process.env[`AZURE_STORAGE_CONNECTION_${connectionNr}_CONTAINER`]?.trim();
}
if (!container?.length) {
throw new Error('No container defined');
}
return {
...storageOpts,
container
};
};
/**
* Creates a new factory function, that provides a blob storage client by name.
*
* @example
* ```
* import { createGetBlobServiceClientFactory } from '@egomobile/azure-storage'
*
* // create factory function
* const getClient = createGetBlobServiceClientFactory(() => {
* url: '<YOUR-CONNECTION-URL>'
* });
*
* // now get client from factory
* const client = getClient()
* ```
*
* @param {GetBlobStorageClientOptions|IBlobStorageClientOptions} [optionsOrFunc] The custom options or function that provide them.
*
* @returns {BlobServiceClientProvider} The new factory function.
*/
export function createGetBlobServiceClientFactory(optionsOrFunc: GetBlobStorageClientOptions | IBlobStorageClientOptions = defaultGetBlobStorageClientOptions): BlobServiceClientProvider {
let getOptions: GetBlobStorageClientOptions;
if (typeof optionsOrFunc === 'function') {
getOptions = optionsOrFunc;
} else {
getOptions = () => optionsOrFunc;
}
if (typeof getOptions !== 'function') {
throw new TypeError('optionsOrFunc must be a function or object');
}
return (name) => {
const { url } = getOptions(name);
return BlobServiceClient.fromConnectionString(url);
};
}
/**
* Creates a new factory function, that provides a container client by name and container name.
*
* @example
* ```
* import { createGetContainerClientFactory } from '@egomobile/azure-storage'
*
* // create factory function
* const getClient = createGetContainerClientFactory(() => {
* url: '<YOUR-CONNECTION-URL>',
* container: 'my-container'
* });
*
* // now get client from factory
* const client = getClient()
* ```
*
* @param {GetContainerClientOptions|IContainerClientOptions} [optionsOrFunc] The custom options or function that provide them.
*
* @returns {ContainerClientProvider} The new factory function.
*/
export function createGetContainerClientFactory(optionsOrFunc: GetContainerClientOptions | IContainerClientOptions = defaultGetContainerClientOptions): ContainerClientProvider {
let getOptions: GetContainerClientOptions;
if (typeof optionsOrFunc === 'function') {
getOptions = optionsOrFunc;
} else {
getOptions = () => optionsOrFunc;
}
if (typeof getOptions !== 'function') {
throw new TypeError('optionsOrFunc must be a function or object');
}
return (name, customContainer?) => {
const { container, url } = getOptions(name, customContainer);
return BlobServiceClient.fromConnectionString(url)
.getContainerClient(container);
};
}
/**
* Returns the a blob storage client, that is using environment variables
* to setup the client.
*
* @example
* ```
* import { getBlobServiceClient } from '@egomobile/azure-storage'
*
* // setup the following environment variables:
* //
* // - AZURE_STORAGE_CONNECTION_1=my-connection
* // - AZURE_STORAGE_CONNECTION_1_CONTAINER=my_container
* // - AZURE_STORAGE_CONNECTION_1_URL=<YOUR-CONNECTION-URL>
*
* const client = getBlobServiceClient('my-connection')
* ```
*
* The variables must have the following structure:
*
* - AZURE_STORAGE_CONNECTION_{NR} => the name of the connection
* - AZURE_STORAGE_CONNECTION_{NR}_URL => the connection URL
*/
export const getBlobServiceClient = createGetBlobServiceClientFactory(defaultGetBlobStorageClientOptions);
/**
* Returns the a container client, that is using environment variables
* to setup the client.
*
* @example
* ```
* import { getContainerClient } from '@egomobile/azure-storage'
*
* // setup the following environment variables:
* //
* // - AZURE_STORAGE_CONNECTION_1=my-connection
* // - AZURE_STORAGE_CONNECTION_1_CONTAINER=my_container
* // - AZURE_STORAGE_CONNECTION_1_URL=<YOUR-CONNECTION-URL>
*
* const client = getContainerClient('my-connection')
* ```
*
* The variables must have the following structure:
*
* - AZURE_STORAGE_CONNECTION_{NR} => the name of the connection
* - AZURE_STORAGE_CONNECTION_{NR}_CONTAINER => the default container name
* - AZURE_STORAGE_CONNECTION_{NR}_URL => the connection URL
*/
export const getContainerClient = createGetContainerClientFactory(defaultGetContainerClientOptions);
function getAzureStorageConnectionNrFromEnvVar(name: string): number {
const r = /^(AZURE_STORAGE_CONNECTION_)(\d+)$/;
const connectionNr = parseInt(
Object.keys(process.env)
.filter(k => r.test(k)) // take all vars with name of format MONGO_CONNECTION_<NR>
.filter(k => process.env[k]?.trim() === name) // take with value of 'name'
.map(k => k.split('_')[3])[0] // take the <NR> part
);
if (isNaN(connectionNr)) {
throw new Error(`No azure storage connection ${name} found or defined`);
}
return connectionNr;
}