fix(aws-apigateway): allow + in path parts (#769)

dan · rix0rrr · commit 9aadcb620db9 · 2018-10-02T10:18:59.000+02:00
The RegEx was too restrictive when being used with proxy variables. The \+ in {proxy+} is valid and should not throw an exception. Fixes #768.
diff --git a/packages/@aws-cdk/aws-apigateway/lib/resource.ts b/packages/@aws-cdk/aws-apigateway/lib/resource.ts
@@ -138,9 +138,15 @@ function validateResourcePathPart(part: string) {
   // strip {} which indicate this is a parameter
   if (part.startsWith('{') && part.endsWith('}')) {
     part = part.substr(1, part.length - 2);
+
+    // proxy resources are allowed to end with a '+'
+    if (part.endsWith('+')) {
+      part = part.substr(0, part.length - 1);
+    }
   }
 
   if (!/^[a-zA-Z0-9\.\_\-]+$/.test(part)) {
-    throw new Error(`Resource's path part only allow a-zA-Z0-9._- and curly braces at the beginning and the end: ${part}`);
+    throw new Error(`Resource's path part only allow [a-zA-Z0-9._-], an optional trailing '+'
+      and curly braces at the beginning and the end: ${part}`);
   }
 }
diff --git a/packages/@aws-cdk/aws-apigateway/test/test.restapi.ts b/packages/@aws-cdk/aws-apigateway/test/test.restapi.ts
@@ -223,6 +223,27 @@ export = {
     test.done();
   },
 
+  '"addResource" allows configuration of proxy paths'(test: Test) {
+    // GIVEN
+    const stack = new cdk.Stack();
+    const api = new apigateway.RestApi(stack, 'restapi', {
+      deploy: false,
+      cloudWatchRole: false,
+      restApiName: 'my-rest-api'
+    });
+
+    // WHEN
+    const proxy = api.root.addResource('{proxy+}');
+    proxy.addMethod('ANY');
+
+    // THEN
+    expect(stack).to(haveResource('AWS::ApiGateway::Resource', {
+      PathPart: "{proxy+}",
+      ParentId: { "Fn::GetAtt": ["restapiC5611D27", "RootResourceId"] }
+    }));
+    test.done();
+  },
+
   '"addMethod" can be used to add methods to resources'(test: Test) {
     // GIVEN
     const stack = new cdk.Stack();

Original file line number	Diff line number	Diff line change
`@@ -138,9 +138,15 @@ function validateResourcePathPart(part: string) {`
`138`	`138`	`// strip {} which indicate this is a parameter`
`139`	`139`	`if (part.startsWith('{') && part.endsWith('}')) {`
`140`	`140`	`part = part.substr(1, part.length - 2);`
	`141`	`+`
	`142`	`+ // proxy resources are allowed to end with a '+'`
	`143`	`+ if (part.endsWith('+')) {`
	`144`	`+ part = part.substr(0, part.length - 1);`
	`145`	`+ }`
`141`	`146`	`}`
`142`	`147`
`143`	`148`	`if (!/^[a-zA-Z0-9\.\_\-]+$/.test(part)) {`
`144`		- throw new Error(`Resource's path part only allow a-zA-Z0-9._- and curly braces at the beginning and the end: ${part}`);
	`149`	+ throw new Error(`Resource's path part only allow [a-zA-Z0-9._-], an optional trailing '+'
	`150`	+ and curly braces at the beginning and the end: ${part}`);
`145`	`151`	`}`
`146`	`152`	`}`