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: upgrade s3 to v3 #31

Merged
merged 1 commit into from
Dec 8, 2023
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
3 changes: 2 additions & 1 deletion packages/oss-upload-tool/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@
"@planjs/utils": "^1.5.1",
"@types/ali-oss": "^6.16.3",
"ali-oss": "^6.17.1",
"aws-sdk": "^2.1294.0",
"@aws-sdk/client-s3": "3.449.0",
"@aws-sdk/lib-storage": "3.449.0",
"cos-nodejs-sdk-v5": "^2.11.9",
"stan-utils": "0.15.0"
},
Expand Down
1 change: 0 additions & 1 deletion packages/oss-upload-tool/src/client/ali.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { join } from 'path';
import { URL } from 'url';

import AOSS from 'ali-oss';
Expand Down
2 changes: 0 additions & 2 deletions packages/oss-upload-tool/src/client/cos.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import { join } from 'path';

import COS from 'cos-nodejs-sdk-v5';
import { REG_URI } from '@planjs/utils';
import { lodash } from 'stan-utils';
Expand Down
93 changes: 51 additions & 42 deletions packages/oss-upload-tool/src/client/s3.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
import { createReadStream } from 'fs';
import { URL } from 'url';

import { S3 } from 'aws-sdk';
import { defer } from '@planjs/utils';
import { S3Client as S3 } from '@aws-sdk/client-s3';
import type { S3ClientConfig, PutObjectCommandInput } from '@aws-sdk/client-s3';
import { Upload } from '@aws-sdk/lib-storage';
import { AbortController } from '@smithy/abort-controller';
import { lodash } from 'stan-utils';

import { Client } from '../oss_client';
Expand All @@ -22,7 +24,7 @@ import {
UPLOAD_TIMEOUT_KEY,
} from '../consts';

class S3Client extends Client<Partial<S3.Types.ClientConfiguration>, S3.Types.PutObjectRequest> {
class S3Client extends Client<Partial<S3ClientConfig>, PutObjectCommandInput> {
readonly #client!: S3;

constructor(options: OSSUploadOptions) {
Expand All @@ -46,66 +48,73 @@ class S3Client extends Client<Partial<S3.Types.ClientConfiguration>, S3.Types.Pu
};
};

get globalOptions(): Partial<Partial<S3.ClientConfiguration>> {
get globalOptions(): Partial<Partial<S3ClientConfig>> {
const accessKeyId = getGlobalValue(S3_SECRET_ID, SECRET_ID)!;
const secretAccessKey = getGlobalValue(S3_SECRET_KEY, SECRET_KEY)!;
const region = getGlobalValue(S3_REGION_KEY, BUCKET_KEY)!;
const timeout = getGlobalValue(UPLOAD_TIMEOUT_KEY);
return {
credentials: {
accessKeyId,
secretAccessKey,
},
region,
httpOptions: {
timeout: Number.isNaN(+timeout!)
? defaultVal(this.opt.timeout, DEFAULT_TIMEOUT)
: +timeout!,
},
};
}

get globalUploadParams(): Partial<S3.Types.PutObjectRequest> {
get globalUploadParams(): Partial<PutObjectCommandInput> {
const Bucket = getGlobalValue(S3_BUCKET_KEY, REGION_KEY)!;
return {
Bucket,
};
}

upload = (
getTimeout() {
const timeout = getGlobalValue(UPLOAD_TIMEOUT_KEY);

return Number.isNaN(+timeout!) ? defaultVal(this.opt.timeout, DEFAULT_TIMEOUT) : +timeout!;
}

upload = async (
item: OSSUploadLocalItem,
params?: Partial<S3.Types.PutObjectRequest>,
params?: Partial<PutObjectCommandInput>,
options?: UploadOptions,
): Promise<UploadResp> => {
const p = defer<UploadResp>();
this.#client
.upload(
{
Bucket: '',
Key: item.path,
Body: createReadStream(item.filePath),
...this.globalUploadParams,
...params,
},
{
partSize: 1024 * 1024 * 5,
...options,
},
(err, data) => {
if (err) {
p.reject(err);
return;
}
p.resolve({
...data,
url: data.Location,
});
},
)
.on('httpUploadProgress', (info) => {
options?.onProgress?.(info.loaded, info.total);
});
return p.promise;
const _params = {
Bucket: '',
Key: item.path,
Body: createReadStream(item.filePath),
...this.globalUploadParams,
...params,
};

const abortController = new AbortController();

const parallelUploads3 = new Upload({
client: this.#client,
params: _params,
queueSize: 4,
partSize: 1024 * 1024 * 5,
leavePartsOnError: false,
abortController,
});

const timer = setTimeout(() => {
abortController.abort();
}, this.getTimeout());

parallelUploads3.on('httpUploadProgress', (progress) => {
options?.onProgress?.(progress.loaded! || 0, progress.total! || 0);
});

try {
const res = await parallelUploads3.done();
return {
...res,
...(await this.getUploadedUrl(item, _params)),
} as UploadResp;
} finally {
clearTimeout(timer);
}
};
}

Expand Down
6 changes: 3 additions & 3 deletions packages/oss-upload-tool/src/types.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import type COS from 'cos-nodejs-sdk-v5';
import type AOSS from 'ali-oss';
import type { S3 } from 'aws-sdk';
import type { S3ClientConfig, PutObjectCommandInput } from '@aws-sdk/client-s3';

/**
* 上传参数
*/
type UploadParams =
| Partial<COS.UploadFileParams>
| Partial<AOSS.PutObjectOptions>
| Partial<S3.Types.PutObjectRequest>;
| Partial<PutObjectCommandInput>;

/**
* 对象存储类型
Expand Down Expand Up @@ -73,7 +73,7 @@ export interface OSSUploadOptions {
/**
* S3 初始化参数
*/
S3Options?: S3.Types.ClientConfiguration;
S3Options?: S3ClientConfig;
/**
* 当前 CDN 对外访问域名,需要带协议
* existCheck 检查,如果默认cdn域名无法访问,使用开放访问的 cdn 域名进行检查
Expand Down
Loading
Loading