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

Jump to bottom

fix(custom-resources): Custom resource provider framework not passing ResponseURL to user function #21117

Merged
merged 1 commit into from
Jul 13, 2022
Merged

fix(custom-resources): Custom resource provider framework not passing ResponseURL to user function #21117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions packages/@aws-cdk/custom-resources/lib/provider-framework/runtime/framework.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ async function onEvent(cfnRequest: AWSLambda.CloudFormationCustomResourceEvent)

cfnRequest.ResourceProperties = cfnRequest.ResourceProperties || { };

const onEventResult = await invokeUserFunction(consts.USER_ON_EVENT_FUNCTION_ARN_ENV, sanitizedRequest) as OnEventResponse;
const onEventResult = await invokeUserFunction(consts.USER_ON_EVENT_FUNCTION_ARN_ENV, sanitizedRequest, cfnRequest.ResponseURL) as OnEventResponse;
log('onEvent returned:', onEventResult);

// merge the request and the result from onEvent to form the complete resource event
Expand Down Expand Up @@ -61,7 +61,7 @@ async function isComplete(event: AWSCDKAsyncCustomResource.IsCompleteRequest) {
const sanitizedRequest = { ...event, ResponseURL: '...' } as const;
log('isComplete', sanitizedRequest);

const isCompleteResult = await invokeUserFunction(consts.USER_IS_COMPLETE_FUNCTION_ARN_ENV, sanitizedRequest) as IsCompleteResponse;
const isCompleteResult = await invokeUserFunction(consts.USER_IS_COMPLETE_FUNCTION_ARN_ENV, sanitizedRequest, event.ResponseURL) as IsCompleteResponse;
log('user isComplete returned:', isCompleteResult);

// if we are not complete, return false, and don't send a response back.
Expand Down Expand Up @@ -96,7 +96,7 @@ async function onTimeout(timeoutEvent: any) {
});
}

async function invokeUserFunction<A extends { ResponseURL: '...' }>(functionArnEnv: string, sanitizedPayload: A) {
async function invokeUserFunction<A extends { ResponseURL: '...' }>(functionArnEnv: string, sanitizedPayload: A, responseUrl: string) {
const functionArn = getEnv(functionArnEnv);
log(`executing user function ${functionArn} with payload`, sanitizedPayload);

Expand All @@ -106,8 +106,8 @@ async function invokeUserFunction<A extends { ResponseURL: '...' }>(functionArnE
const resp = await invokeFunction({
FunctionName: functionArn,

// Strip 'ResponseURL' -- the downstream CR doesn't need it and can only log it by accident
Payload: JSON.stringify({ ...sanitizedPayload, ResponseURL: undefined }),
// Cannot strip 'ResponseURL' here as this would be a breaking change even though the downstream CR doesn't need it
Payload: JSON.stringify({ ...sanitizedPayload, ResponseURL: responseUrl }),
});

log('user function response:', resp, typeof(resp));
Expand Down
38 changes: 38 additions & 0 deletions packages/@aws-cdk/custom-resources/test/provider-framework/runtime.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ outbound.httpRequest = mocks.httpRequestMock;
outbound.invokeFunction = mocks.invokeFunctionMock;
outbound.startExecution = mocks.startExecutionMock;

const invokeFunctionSpy = jest.spyOn(outbound, 'invokeFunction');

beforeEach(() => mocks.setup());
afterEach(() => invokeFunctionSpy.mockClear());

test('async flow: isComplete returns true only after 3 times', async () => {
let isCompleteCalls = 0;
Expand Down Expand Up @@ -346,6 +349,41 @@ describe('if CREATE fails, the subsequent DELETE will be ignored', () => {

});

describe('ResponseURL is passed to user function', () => {
test('for onEvent', async () => {
// GIVEN
mocks.onEventImplMock = async () => ({ PhysicalResourceId: MOCK_PHYSICAL_ID });

// WHEN
await simulateEvent({
RequestType: 'Create',
});

// THEN
expect(invokeFunctionSpy).toHaveBeenCalledTimes(1);
expect(invokeFunctionSpy).toBeCalledWith(expect.objectContaining({
Payload: expect.stringContaining(`"ResponseURL":"${mocks.MOCK_REQUEST.ResponseURL}"`),
}));
});

test('for isComplete', async () => {
// GIVEN
mocks.onEventImplMock = async () => ({ PhysicalResourceId: MOCK_PHYSICAL_ID });
mocks.isCompleteImplMock = async () => ({ IsComplete: true });

// WHEN
await simulateEvent({
RequestType: 'Create',
});

// THEN
expect(invokeFunctionSpy).toHaveBeenCalledTimes(2);
expect(invokeFunctionSpy).toHaveBeenLastCalledWith(expect.objectContaining({
Payload: expect.stringContaining(`"ResponseURL":"${mocks.MOCK_REQUEST.ResponseURL}"`),
}));
});
});

// -----------------------------------------------------------------------------------------------------------------------

/**
Expand Down