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.

Sign up for GitHub

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

Upgrade to @aws-sdk v3 #627

Merged
merged 2 commits into from
Jan 19, 2024
Merged

Upgrade to @aws-sdk v3 #627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
42b5983
Upgrade to @aws-sdk v3
Danno040 Jan 17, 2024
4de6abc
Update e2e test
Danno040 Jan 18, 2024
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
34 changes: 15 additions & 19 deletions packages/reg-publish-s3-plugin/e2e/script.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { S3PublisherPlugin } from "../lib/s3-publisher-plugin";
import { S3BucketPreparer } from "../lib/s3-bucket-preparer";
import glob from "glob";
import assert from "assert";
import { S3 } from "aws-sdk";
import { DeleteBucketCommand, DeleteObjectsCommand, ListObjectsV2Command, S3Client } from "@aws-sdk/client-s3";

const preparer = new S3BucketPreparer();

Expand All @@ -28,28 +28,24 @@ const dirsB = {
expectedDir: __dirname + "/../e2e/report-fixture-expected/dir_b",
diffDir: "",
};

async function after(bn: string) {
await new Promise(resolve => {
new S3().listObjects(
{
const S3 = new S3Client();
const result = await S3.send(
new ListObjectsV2Command({
Bucket: bn,
}),
);

if (result.Contents?.length) {
await S3.send(
new DeleteObjectsCommand({
Bucket: bn,
},
(_err, result) => {
if (result.Contents) {
new S3().deleteObjects(
{
Bucket: bn,
Delete: { Objects: result.Contents.map(c => ({ Key: c.Key as any })) },
},
(__err, x) => resolve(x),
);
}
},
Delete: { Objects: result.Contents.map(c => ({ Key: c.Key as any })) },
}),
);
});
}

await new Promise(resolve => new S3().deleteBucket({ Bucket: bn }, resolve));
await S3.send(new DeleteBucketCommand({ Bucket: bn }));
}

async function case1() {
Expand Down
2 changes: 1 addition & 1 deletion packages/reg-publish-s3-plugin/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"repository": "git+https://github.com/reg-viz/reg-suit.git",
"license": "MIT",
"dependencies": {
"aws-sdk": "^2.755.0",
"@aws-sdk/client-s3": "^3.485.0",
"mkdirp": "^1.0.4",
"reg-suit-util": "^0.12.2",
"uuid": "^8.3.0"
Expand Down
53 changes: 19 additions & 34 deletions packages/reg-publish-s3-plugin/src/s3-bucket-preparer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { v4 as uuid } from "uuid";
import { S3, config as awsConfig } from "aws-sdk";
import { CreateBucketCommand, PutBucketPolicyCommand, S3Client } from "@aws-sdk/client-s3";
import { PluginPreparer, PluginCreateOptions, PluginLogger } from "reg-suit-interface";
import { PluginConfig } from "./s3-publisher-plugin";

Expand Down Expand Up @@ -27,7 +27,7 @@ function createPolicy(bucketName: string) {
const BUCKET_PREFIX = "reg-publish-bucket";

export class S3BucketPreparer implements PluginPreparer<SetupInquireResult, PluginConfig> {
private _s3client = new S3();
private _s3client = new S3Client();
_logger!: PluginLogger;

inquire() {
Expand Down Expand Up @@ -57,15 +57,6 @@ export class S3BucketPreparer implements PluginPreparer<SetupInquireResult, Plug
} else {
const id = uuid();
const bucketName = `${BUCKET_PREFIX}-${id}`;
if (!awsConfig.credentials || !awsConfig.credentials.accessKeyId) {
this._logger.warn("Failed to read AWS credentials.");
this._logger.warn(
`Create ${this._logger.colors.magenta("~/.aws/credentials")} or export ${this._logger.colors.green(
"$AWS_ACCESS_KEY_ID",
)} and ${this._logger.colors.green("$AWS_SECRET_ACCESS_KEY")}.`,
);
return Promise.resolve({ bucketName: "your_s3_bucket_name" });
}
if (config.noEmit) {
this._logger.info(`Skip to create S3 bucket ${bucketName} because noEmit option.`);
return Promise.resolve({ bucketName });
Expand All @@ -86,34 +77,28 @@ export class S3BucketPreparer implements PluginPreparer<SetupInquireResult, Plug

_updatePolicy(bucketName: string) {
return new Promise<string>((resolve, reject) => {
this._s3client.putBucketPolicy(
{
Bucket: bucketName,
Policy: JSON.stringify(createPolicy(bucketName)),
},
err => {
if (err) {
return reject(err);
}
resolve(bucketName);
},
);
this._s3client
.send(
new PutBucketPolicyCommand({
Bucket: bucketName,
Policy: JSON.stringify(createPolicy(bucketName)),
}),
)
.then(() => resolve(bucketName))
.catch(err => reject(err));
});
}

_createBucket(bucketName: string) {
return new Promise<string>((resolve, reject) => {
this._s3client.createBucket(
{
Bucket: bucketName,
},
err => {
if (err) {
return reject(err);
}
return resolve(bucketName);
},
);
this._s3client
.send(
new CreateBucketCommand({
Bucket: bucketName,
}),
)
.then(() => resolve(bucketName))
.catch(err => reject(err));
});
}
}
123 changes: 74 additions & 49 deletions packages/reg-publish-s3-plugin/src/s3-publisher-plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
import fs from "fs";
import path from "path";
import zlib from "zlib";
import { S3 } from "aws-sdk";
import {
GetObjectCommand,
GetObjectCommandOutput,
ListObjectsV2Command,
ListObjectsV2Output,
ObjectCannedACL,
PutObjectCommand,
S3Client,
S3ClientConfig,
ServerSideEncryption,
} from "@aws-sdk/client-s3";
import mkdirp from "mkdirp";

import { PublisherPlugin, PluginCreateOptions, WorkingDirectoryInfo } from "reg-suit-interface";
Expand All @@ -11,20 +21,20 @@ export interface PluginConfig {
bucketName: string;
pattern?: string;
enableACL?: boolean;
acl?: string;
sse?: boolean | string;
acl?: ObjectCannedACL;
sse?: boolean | ServerSideEncryption;
sseKMSKeyId?: string;
customDomain?: string;
pathPrefix?: string;
sdkOptions?: S3.Types.ClientConfiguration;
sdkOptions?: S3ClientConfig;
}

export class S3PublisherPlugin extends AbstractPublisher implements PublisherPlugin<PluginConfig> {
name = "reg-publish-s3-plugin";

private _options!: PluginCreateOptions<any>;
private _pluginConfig!: PluginConfig;
private _s3client!: S3;
private _s3client!: S3Client;

constructor() {
super();
Expand All @@ -37,7 +47,7 @@ export class S3PublisherPlugin extends AbstractPublisher implements PublisherPlu
this._pluginConfig = {
...config.options,
};
this._s3client = new S3(this._pluginConfig.sdkOptions);
this._s3client = new S3Client(this._pluginConfig.sdkOptions ?? {});
}

publish(key: string) {
Expand Down Expand Up @@ -86,24 +96,28 @@ export class S3PublisherPlugin extends AbstractPublisher implements PublisherPlu
if (this._pluginConfig.enableACL == undefined) {
this._pluginConfig.enableACL = true;
}
const req = {
const req = new PutObjectCommand({
Bucket: this._pluginConfig.bucketName,
Key: `${key}/${item.path}`,
Body: data,
ContentType: item.mimeType,
ContentEncoding: "gzip",
ACL: this._pluginConfig.enableACL ? this._pluginConfig.acl || "public-read" : undefined,
ACL: this._pluginConfig.enableACL ? this._pluginConfig.acl || ObjectCannedACL.public_read : undefined,
SSEKMSKeyId: this._pluginConfig.sseKMSKeyId,
} as S3.Types.PutObjectRequest;
});
if (this._pluginConfig.sse) {
const sseVal = this._pluginConfig.sse;
req.ServerSideEncryption = typeof sseVal === "string" ? sseVal : "AES256";
req.input.ServerSideEncryption = typeof sseVal === "string" ? sseVal : ServerSideEncryption.AES256;
}
this._s3client.putObject(req, err => {
if (err) return reject(err);
this.logger.verbose(`Uploaded from ${item.absPath} to ${key}/${item.path}`);
return resolve(item);
});
this._s3client
.send(req)
.then(() => {
this.logger.verbose(`Uploaded from ${item.absPath} to ${key}/${item.path}`);
return resolve(item);
})
.catch(err => {
return reject(err);
});
});
});
});
Expand All @@ -112,17 +126,16 @@ export class S3PublisherPlugin extends AbstractPublisher implements PublisherPlu
protected downloadItem(remoteItem: RemoteFileItem, item: FileItem): Promise<FileItem> {
const s3Key = remoteItem.remotePath;
return new Promise((resolve, reject) => {
this._s3client.getObject(
{
Bucket: this._pluginConfig.bucketName,
Key: `${s3Key}`,
},
(err, x) => {
if (err) {
return reject(err);
}
this._s3client
.send(
new GetObjectCommand({
Bucket: this._pluginConfig.bucketName,
Key: `${s3Key}`,
}),
)
.then((result: GetObjectCommandOutput) => {
mkdirp.sync(path.dirname(item.absPath));
this._gunzipIfNeed(x, (_err, content) => {
this._gunzipIfNeed(result, (_err, content) => {
fs.writeFile(item.absPath, content, err => {
if (err) {
return reject(err);
Expand All @@ -131,8 +144,10 @@ export class S3PublisherPlugin extends AbstractPublisher implements PublisherPlu
resolve(item);
});
});
},
);
})
.catch(err => {
return reject(err);
});
});
}

Expand All @@ -153,32 +168,42 @@ export class S3PublisherPlugin extends AbstractPublisher implements PublisherPlu
}

return new Promise<ObjectListResult>((resolve, reject) => {
this._s3client.listObjects(options, async (err, result: S3.ListObjectsOutput) => {
if (err) {
reject(err);
}

let nextMarker: string | undefined;
if (result.Contents && result.Contents.length > 0 && result.IsTruncated) {
nextMarker = result.Contents[result.Contents.length - 1].Key;
}
this._s3client
.send(new ListObjectsV2Command(options))
.then((result: ListObjectsV2Output) => {
let nextMarker: string | undefined;
if (result.Contents && result.Contents.length > 0 && result.IsTruncated) {
nextMarker = result.Contents[result.Contents.length - 1].Key;
}

resolve({
isTruncated: result.IsTruncated,
contents: !result.Contents ? [] : result.Contents.map(f => ({ key: f.Key })),
nextMarker,
} as ObjectListResult);
});
resolve({
isTruncated: result.IsTruncated,
contents: !result.Contents ? [] : result.Contents.map(f => ({ key: f.Key })),
nextMarker,
} as ObjectListResult);
})
.catch(err => reject(err));
});
}

private _gunzipIfNeed(output: S3.GetObjectOutput, cb: (err: any, data: Buffer) => any) {
if (output.ContentEncoding === "gzip") {
zlib.gunzip(output.Body as Buffer, (err, content) => {
cb(err, content);
});
} else {
cb(null, output.Body as Buffer);
private _gunzipIfNeed(result: GetObjectCommandOutput, cb: (err: any, data: Buffer) => any) {
if (!result.Body) {
cb(new Error("No body returned!"), Buffer.from(""));
}

result
.Body!.transformToString()
.then(body => {
if (result.ContentEncoding === "gzip") {
zlib.gunzip(Buffer.from(body), (err, content) => {
cb(err, content);
});
} else {
cb(null, Buffer.from(body));
}
})
.catch(err => {
cb(err, Buffer.from(""));
});
}
}
Loading
Loading