Skip to content

feat(middleware-bucket-endpoint): add object lambda support #2143

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

Merged
merged 7 commits into from
Mar 17, 2021
Merged

feat(middleware-bucket-endpoint): add object lambda support #2143

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f8c1b62
fix(middleware-bucket-endpoint): bugfixing the s3 endpoint parser
alexforsyth Feb 26, 2021
cbe3bba
fix(middleware-bucket-endpoint): add tests
alexforsyth Feb 26, 2021
47be019
fix: remove latent debugger
alexforsyth Feb 26, 2021
492d889
feat: add robust tests to object lambda
alexforsyth Mar 4, 2021
c1be84c
Merge branch 'main' of github.com:aws/aws-sdk-js-v3 into object-lambda
alexforsyth Mar 16, 2021
54cd6b1
fix: adding object lambda to service validation
alexforsyth Mar 16, 2021
d4b5f6a
fix: fixing error messages in tests
alexforsyth Mar 17, 2021
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
208 changes: 207 additions & 1 deletion packages/middleware-bucket-endpoint/src/bucketHostname.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ describe("bucketHostname", () => {
[
{
bucketArn: "arn:aws:sqs:us-west-2:123456789012:someresource",
message: "Expect 's3' or 's3-outposts' in ARN service component",
message: "Expect 's3' or 's3-outposts' or 's3-object-lambda' in ARN service component",
},
{
bucketArn: "arn:aws:s3:us-west-2:123456789012:bucket_name:mybucket",
Expand Down Expand Up @@ -713,4 +713,210 @@ describe("bucketHostname", () => {
expect(signingService).toBe("s3-outposts");
});
});

describe("from Object Lamdba ARN", () => {
describe("populates access point endpoint from ARN", () => {
it("should use the proper endpoint", () => {
const region = "eu-west-1";
const expectedEndpoint = "js-sdk-ap-name-123456789012.s3-object-lambda.eu-west-1.amazonaws.com";
["arn:aws:s3-object-lambda:eu-west-1:123456789012:accesspoint/js-sdk-ap-name"].forEach((outpostArn) => {
const { bucketEndpoint, hostname } = bucketHostname({
bucketName: parseArn(outpostArn),
baseHostname: "s3.eu-west-1.amazonaws.com",
isCustomEndpoint: false,
clientRegion: region,
});
expect(bucketEndpoint).toBe(true);
expect(hostname).toBe(expectedEndpoint);
});
});
});

it("should not be able to use accelerate", () => {
try {
bucketHostname({
bucketName: parseArn("arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner"),
baseHostname: "s3.us-west-2.amazonaws.com",
isCustomEndpoint: false,
clientRegion: "us-west-2",
accelerateEndpoint: true,
});
// should never get here
expect(1).toEqual(0);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: this won't provide very useful error message, you can validate exactly 1 assertion is called by expect.assertions(1);. Same to other unit tests.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ahh TIL. I'll update

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not entirely sure how to replace this with expect.assertion() since this expect shouldn't ever be called here to begin with. I'm thinking possibly change the error message? Maybe something like:

expect("This configuration is invalid and should never get to this line").toEqual(0);

} catch (e) {
// should throw since these are error cases
expect(1).toEqual(1);
}
});

it("should not be able to use dualstack", () => {
try {
bucketHostname({
bucketName: parseArn("arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner"),
baseHostname: "s3.us-west-2.amazonaws.com",
isCustomEndpoint: false,
clientRegion: "us-west-2",
dualstackEndpoint: true,
});
// should never get here
expect(1).toEqual(0);
} catch (e) {
// should throw since these are error cases
expect(1).toEqual(1);
}
});

it("should support a custom endpoint", () => {
const { hostname } = bucketHostname({
bucketName: parseArn("arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner"),
baseHostname: "my-endpoint.com",
isCustomEndpoint: true,
clientRegion: "us-west-2",
});
expect(hostname).toEqual("mybanner-123456789012.s3-object-lambda.us-west-2.my-endpoint.com");
});

describe("object lambda general test cases", () => {
it("should match expectations in valid configurations", () => {
const validLambdaExpectations: [string, string, boolean, string][] = [
[
"arn:aws:s3-object-lambda:us-west-2:1123456789012:accesspoint/mybanner",
"us-west-2",
false,
"mybanner-1123456789012.s3-object-lambda.us-west-2.amazonaws.com",
],
[
"arn:aws:s3-object-lambda:us-west-2:2123456789012:accesspoint:mybanner",
"us-west-2",
false,
"mybanner-2123456789012.s3-object-lambda.us-west-2.amazonaws.com",
],
[
"arn:aws:s3-object-lambda:us-east-1:3123456789012:accesspoint/mybanner",
"us-west-2",
true,
"mybanner-3123456789012.s3-object-lambda.us-east-1.amazonaws.com",
],
[
"arn:aws:s3-object-lambda:us-east-1:4123456789012:accesspoint/mybanner",
"s3-external-1",
true,
"mybanner-4123456789012.s3-object-lambda.us-east-1.amazonaws.com",
],
[
"arn:aws:s3-object-lambda:us-east-1:5123456789012:accesspoint/mybanner",
"aws-global",
true,
"mybanner-5123456789012.s3-object-lambda.us-east-1.amazonaws.com",
],
];
validLambdaExpectations.forEach((lambdaArn) => {
const arn = lambdaArn[0];
const region = lambdaArn[1];
const useArnRegion = lambdaArn[2];
const exoectedEndpoint = lambdaArn[3];
const { bucketEndpoint, hostname } = bucketHostname({
bucketName: parseArn(arn),
baseHostname: `s3.${region}.amazonaws.com`,
isCustomEndpoint: false,
clientRegion: region,
useArnRegion: useArnRegion,
});
expect(bucketEndpoint).toBe(true);
expect(hostname).toBe(exoectedEndpoint);
});
});

it("should match not work with invalid configurations", () => {
const invalidLambdaConfigurations: [string, string, boolean, string][] = [
[
"arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner",
"us-west-2",
false,
"Invalid configuration, cross region Access Point ARN",
],
[
"arn:aws-cn:s3-object-lambda:cn-north-1:123456789012:accesspoint/mybanner",
"us-west-2",
true,
"Invalid configuration, cross partition Access Point ARN",
],
[
"arn:aws:sqs:us-west-2:123456789012:someresource",
"us-west-2",
false,
"Invalid ARN not S3 Access Point ARN",
],
[
"arn:aws:s3-object-lambda:us-west-2:123456789012:bucket_name:mybucket",
"us-west-2",
false,
"Invalid ARN not S3 Access Point ARN",
],
[
"arn:aws:s3-object-lambda::123456789012:accesspoint/mybanner",
"us-west-2",
false,
"Invalid ARN, missing region",
],
[
"arn:aws:s3-object-lambda:us-west-2::accesspoint/mybanner",
"us-west-2",
false,
"Invalid ARN, missing account-id",
],
[
"arn:aws:s3-object-lambda:us-west-2:123.45678.9012:accesspoint:mybucket",
"us-west-2",
false,
"Invalid ARN, account-id contains invalid character, ..",
],
[
"arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint",
"us-west-2",
false,
"Invalid ARN, missing Access Point name",
],
[
"arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:*",
"us-west-2",
false,
"Invalid ARN, Access Point Name contains invalid character, *",
],
[
"arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:my.bucket",
"us-west-2",
false,
"Invalid ARN, Access Point Name contains invalid character, .",
],
[
"arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:mybucket:object:foo",
"us-west-2",
false,
"Invalid ARN, Access Point ARN contains sub resources",
],
];

invalidLambdaConfigurations.forEach((lambdaArn) => {
const arn = lambdaArn[0];
const region = lambdaArn[1];
const useArnRegion = lambdaArn[2];
try {
bucketHostname({
bucketName: parseArn(arn),
baseHostname: "s3.us-west-2.amazonaws.com",
isCustomEndpoint: false,
clientRegion: region,
useArnRegion: useArnRegion,
});
// should never get here
expect(1).toEqual(0);
} catch (e) {
// should throw since these are error cases
expect(1).toEqual(1);
}
});
});
});
});
});
17 changes: 13 additions & 4 deletions packages/middleware-bucket-endpoint/src/bucketHostname.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,17 +68,26 @@ const getEndpointFromArn = (options: ArnHostnameParams & { isCustomEndpoint: boo
validateAccountId(accountId);
validateRegion(region, { useArnRegion, clientRegion, clientSigningRegion });
const { accesspointName, outpostId } = getArnResources(resource);
validateDNSHostLabel(`${accesspointName}-${accountId}`, { tlsCompatible });
const DNSHostLabel = `${accesspointName}-${accountId}`;
validateDNSHostLabel(DNSHostLabel, { tlsCompatible });

const endpointRegion = useArnRegion ? region : clientRegion;
const signingRegion = useArnRegion ? region : clientSigningRegion;
if (outpostId) {
if (service === "s3-object-lambda") {
validateNoDualstack(dualstackEndpoint);
return {
bucketEndpoint: true,
hostname: `${DNSHostLabel}.${service}.${endpointRegion}.${hostnameSuffix}`,
signingRegion,
signingService: service,
};
} else if (outpostId) {
// if this is an Outpost ARN
validateOutpostService(service);
validateDNSHostLabel(outpostId, { tlsCompatible });
validateNoDualstack(dualstackEndpoint);
validateNoFIPS(endpointRegion);
const hostnamePrefix = `${accesspointName}-${accountId}.${outpostId}`;
const hostnamePrefix = `${DNSHostLabel}.${outpostId}`;
return {
bucketEndpoint: true,
hostname: `${hostnamePrefix}${isCustomEndpoint ? "" : `.s3-outposts.${endpointRegion}`}.${hostnameSuffix}`,
Expand All @@ -88,7 +97,7 @@ const getEndpointFromArn = (options: ArnHostnameParams & { isCustomEndpoint: boo
}
// construct endpoint from Accesspoint ARN
validateS3Service(service);
const hostnamePrefix = `${accesspointName}-${accountId}`;
const hostnamePrefix = `${DNSHostLabel}`;
return {
bucketEndpoint: true,
hostname: `${hostnamePrefix}${
Expand Down
4 changes: 2 additions & 2 deletions packages/middleware-bucket-endpoint/src/bucketHostnameUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ export const validateArnEndpointOptions = (options: {
};

export const validateService = (service: string) => {
if (service !== "s3" && service !== "s3-outposts") {
throw new Error("Expect 's3' or 's3-outposts' in ARN service component");
if (service !== "s3" && service !== "s3-outposts" && service !== "s3-object-lambda") {
throw new Error("Expect 's3' or 's3-outposts' or 's3-object-lambda' in ARN service component");
}
};

Expand Down