From 0619a8c65a6f5920895dfcea7a40d8e51ba8eb02 Mon Sep 17 00:00:00 2001 From: Russell Keane Date: Thu, 13 Jun 2019 08:57:57 +0100 Subject: [PATCH 1/5] Add validation for boolean parameters --- cloudformation/template.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/cloudformation/template.yaml b/cloudformation/template.yaml index 551cafc15..65ce2eff3 100644 --- a/cloudformation/template.yaml +++ b/cloudformation/template.yaml @@ -108,11 +108,19 @@ Parameters: Type: String Description: Only applicable if creating a custom domain name for your dev portal. Defaults to false, and you'll need to provide your own nameserver hosting. If set to true, a Route53 HostedZone and RecordSet are created for you. Default: 'false' + AllowedValues: + - 'false' + - 'true' + ConstraintDescription: Malformed input - Parameter UseRoute53Nameservers value must be either 'true' or 'false' DevelopmentMode: Type: String Description: Enabling this weakens security features (OAI, SSL, site S3 bucket with public read ACLs, Cognito callback verification, CORS, etc.) for easier development. Do not enable this in production! Additionally, do not update a stack that was previously in development mode to be a production stack; instead, make a new stack that has never been in development mode. Default: 'false' + AllowedValues: + - 'false' + - 'true' + ConstraintDescription: Malformed input - Parameter DevelopmentMode value must be either 'true' or 'false' Conditions: UseCustomDomainName: !And [!And [!Not [!Equals [!Ref CustomDomainName, '']], !Not [!Equals [!Ref CustomDomainNameAcmCertArn, '']]], !Condition NotDevelopmentMode] From cd935d9da1275dc39b97453c831c74cc0cc66a25 Mon Sep 17 00:00:00 2001 From: Russell Keane Date: Thu, 13 Jun 2019 09:08:39 +0100 Subject: [PATCH 2/5] Add validation for the rebuild mode --- cloudformation/template.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/cloudformation/template.yaml b/cloudformation/template.yaml index 551cafc15..3a5288aa8 100644 --- a/cloudformation/template.yaml +++ b/cloudformation/template.yaml @@ -74,6 +74,10 @@ Parameters: Type: String Description: By default, a static asset rebuild doesn't overwrite custom-content. Provide the value `overwrite-content` to replace the custom-content with your local version. Don't do this unless you know what you're doing -- all custom changes in your s3 bucket will be lost. Default: '' + AllowedValues: + - 'overwrite-content' + - '' + ConstraintDescription: Malformed input - Parameter StaticAssetRebuildMode value must be either 'overwrite-content' or left blank. MarketplaceSubscriptionTopicProductCode: Type: String From 4dcd576d768aec22810b28d036bf271d31f4e011 Mon Sep 17 00:00:00 2001 From: Alex Chew Date: Mon, 24 Jun 2019 10:58:45 -0700 Subject: [PATCH 3/5] Redirect index.html to root in frontend router (fixes #260) --- cloudformation/template.yaml | 2 +- dev-portal/package-lock.json | 92 ++++++++++++++++++++++++++---------- dev-portal/src/index.js | 3 ++ 3 files changed, 71 insertions(+), 26 deletions(-) diff --git a/cloudformation/template.yaml b/cloudformation/template.yaml index b925350a9..c0b098dcc 100644 --- a/cloudformation/template.yaml +++ b/cloudformation/template.yaml @@ -111,7 +111,7 @@ Parameters: DevelopmentMode: Type: String - Description: Enabling this weakens security features (OAI, SSL, site S3 bucket with public read ACLs, Cognito callback verification, CORS, etc.) for easier development. Do not enable this in production! Additionally, do not update a stack that was previously in development mode to be a production stack; instead, make a new stack that has never been in development mode. + Description: Enabling this weakens security features (OAI, SSL, site S3 bucket with public read ACLs, Cognito callback verification, CORS, etc.) for easier development. It also breaks frontend routing (except to /index.html), including deep linking and page refresh. Do not enable this in production! Additionally, do not update a stack that was previously in development mode to be a production stack; instead, make a new stack that has never been in development mode. Default: 'false' Conditions: diff --git a/dev-portal/package-lock.json b/dev-portal/package-lock.json index 5ce481058..f16dd673b 100644 --- a/dev-portal/package-lock.json +++ b/dev-portal/package-lock.json @@ -1,6 +1,6 @@ { "name": "dev-portal", - "version": "2.3.2", + "version": "3.0.1", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -3196,7 +3196,8 @@ }, "ansi-regex": { "version": "2.1.1", - "bundled": true + "bundled": true, + "optional": true }, "aproba": { "version": "1.2.0", @@ -3214,11 +3215,13 @@ }, "balanced-match": { "version": "1.0.0", - "bundled": true + "bundled": true, + "optional": true }, "brace-expansion": { "version": "1.1.11", "bundled": true, + "optional": true, "requires": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -3231,15 +3234,18 @@ }, "code-point-at": { "version": "1.1.0", - "bundled": true + "bundled": true, + "optional": true }, "concat-map": { "version": "0.0.1", - "bundled": true + "bundled": true, + "optional": true }, "console-control-strings": { "version": "1.1.0", - "bundled": true + "bundled": true, + "optional": true }, "core-util-is": { "version": "1.0.2", @@ -3342,7 +3348,8 @@ }, "inherits": { "version": "2.0.3", - "bundled": true + "bundled": true, + "optional": true }, "ini": { "version": "1.3.5", @@ -3352,6 +3359,7 @@ "is-fullwidth-code-point": { "version": "1.0.0", "bundled": true, + "optional": true, "requires": { "number-is-nan": "^1.0.0" } @@ -3364,17 +3372,20 @@ "minimatch": { "version": "3.0.4", "bundled": true, + "optional": true, "requires": { "brace-expansion": "^1.1.7" } }, "minimist": { "version": "0.0.8", - "bundled": true + "bundled": true, + "optional": true }, "minipass": { "version": "2.3.5", "bundled": true, + "optional": true, "requires": { "safe-buffer": "^5.1.2", "yallist": "^3.0.0" @@ -3391,6 +3402,7 @@ "mkdirp": { "version": "0.5.1", "bundled": true, + "optional": true, "requires": { "minimist": "0.0.8" } @@ -3463,7 +3475,8 @@ }, "number-is-nan": { "version": "1.0.1", - "bundled": true + "bundled": true, + "optional": true }, "object-assign": { "version": "4.1.1", @@ -3473,6 +3486,7 @@ "once": { "version": "1.4.0", "bundled": true, + "optional": true, "requires": { "wrappy": "1" } @@ -3548,7 +3562,8 @@ }, "safe-buffer": { "version": "5.1.2", - "bundled": true + "bundled": true, + "optional": true }, "safer-buffer": { "version": "2.1.2", @@ -3578,6 +3593,7 @@ "string-width": { "version": "1.0.2", "bundled": true, + "optional": true, "requires": { "code-point-at": "^1.0.0", "is-fullwidth-code-point": "^1.0.0", @@ -3595,6 +3611,7 @@ "strip-ansi": { "version": "3.0.1", "bundled": true, + "optional": true, "requires": { "ansi-regex": "^2.0.0" } @@ -3633,11 +3650,13 @@ }, "wrappy": { "version": "1.0.2", - "bundled": true + "bundled": true, + "optional": true }, "yallist": { "version": "3.0.3", - "bundled": true + "bundled": true, + "optional": true } } }, @@ -6989,7 +7008,8 @@ "ansi-regex": { "version": "2.1.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "aproba": { "version": "1.2.0", @@ -7010,12 +7030,14 @@ "balanced-match": { "version": "1.0.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "brace-expansion": { "version": "1.1.11", "bundled": true, "dev": true, + "optional": true, "requires": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -7030,17 +7052,20 @@ "code-point-at": { "version": "1.1.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "concat-map": { "version": "0.0.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "console-control-strings": { "version": "1.1.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "core-util-is": { "version": "1.0.2", @@ -7157,7 +7182,8 @@ "inherits": { "version": "2.0.3", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "ini": { "version": "1.3.5", @@ -7169,6 +7195,7 @@ "version": "1.0.0", "bundled": true, "dev": true, + "optional": true, "requires": { "number-is-nan": "^1.0.0" } @@ -7183,6 +7210,7 @@ "version": "3.0.4", "bundled": true, "dev": true, + "optional": true, "requires": { "brace-expansion": "^1.1.7" } @@ -7190,12 +7218,14 @@ "minimist": { "version": "0.0.8", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "minipass": { "version": "2.2.4", "bundled": true, "dev": true, + "optional": true, "requires": { "safe-buffer": "^5.1.1", "yallist": "^3.0.0" @@ -7214,6 +7244,7 @@ "version": "0.5.1", "bundled": true, "dev": true, + "optional": true, "requires": { "minimist": "0.0.8" } @@ -7294,7 +7325,8 @@ "number-is-nan": { "version": "1.0.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "object-assign": { "version": "4.1.1", @@ -7306,6 +7338,7 @@ "version": "1.4.0", "bundled": true, "dev": true, + "optional": true, "requires": { "wrappy": "1" } @@ -7391,7 +7424,8 @@ "safe-buffer": { "version": "5.1.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "safer-buffer": { "version": "2.1.2", @@ -7427,6 +7461,7 @@ "version": "1.0.2", "bundled": true, "dev": true, + "optional": true, "requires": { "code-point-at": "^1.0.0", "is-fullwidth-code-point": "^1.0.0", @@ -7446,6 +7481,7 @@ "version": "3.0.1", "bundled": true, "dev": true, + "optional": true, "requires": { "ansi-regex": "^2.0.0" } @@ -7489,12 +7525,14 @@ "wrappy": { "version": "1.0.2", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "yallist": { "version": "3.0.2", "bundled": true, - "dev": true + "dev": true, + "optional": true } } }, @@ -10263,7 +10301,8 @@ "map-obj": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-1.0.1.tgz", - "integrity": "sha1-2TPOuSBdgr3PSIb2dCvcK03qFG0=" + "integrity": "sha1-2TPOuSBdgr3PSIb2dCvcK03qFG0=", + "optional": true }, "map-visit": { "version": "1.0.0", @@ -16837,7 +16876,8 @@ "camelcase": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-3.0.0.tgz", - "integrity": "sha1-MvxLn82vhF/N9+c7uXysImHwqwo=" + "integrity": "sha1-MvxLn82vhF/N9+c7uXysImHwqwo=", + "optional": true }, "cliui": { "version": "3.2.0", @@ -16905,6 +16945,7 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=", + "optional": true, "requires": { "number-is-nan": "^1.0.0" } @@ -17054,6 +17095,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", + "optional": true, "requires": { "code-point-at": "^1.0.0", "is-fullwidth-code-point": "^1.0.0", diff --git a/dev-portal/src/index.js b/dev-portal/src/index.js index 3fe942012..bc991d91a 100644 --- a/dev-portal/src/index.js +++ b/dev-portal/src/index.js @@ -62,6 +62,9 @@ class App extends React.Component { + + + } /> From ba9825c654710ba7d54d24f00bef0996f49ec057 Mon Sep 17 00:00:00 2001 From: Alex Chew Date: Mon, 24 Jun 2019 11:13:31 -0700 Subject: [PATCH 4/5] Reformat README Setup section for improved readability --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f1a544115..e6f98f28c 100644 --- a/README.md +++ b/README.md @@ -30,15 +30,28 @@ If you have previously set up a v1 developer portal (non-SAM deployed), you will #### Deploy Run: + >In the command below, replace the `your-lambda-artifacts-bucket-name` with the name of a bucket that you manage and that already exists. Then, run: + ```bash -sam package --template-file ./cloudformation/template.yaml --output-template-file ./cloudformation/packaged.yaml --s3-bucket your-lambda-artifacts-bucket-name +sam package --template-file ./cloudformation/template.yaml \ + --output-template-file ./cloudformation/packaged.yaml \ + --s3-bucket your-lambda-artifacts-bucket-name ``` -Then run: +Then run: + >In the command below, replace the `your-lambda-artifacts-bucket-name` with the name of a bucket that you manage and that already exists, and replace `custom-prefix` with some prefix that is globally unique, like your org name or username. Then, run: + ```bash -sam deploy --template-file ./cloudformation/packaged.yaml --stack-name "dev-portal" --s3-bucket your-lambda-artifacts-bucket-name --capabilities CAPABILITY_NAMED_IAM --parameter-overrides DevPortalSiteS3BucketName="custom-prefix-dev-portal-static-assets" ArtifactsS3BucketName="custom-prefix-dev-portal-artifacts" CognitoDomainNameOrPrefix="custom-prefix" +sam deploy --template-file ./cloudformation/packaged.yaml \ + --stack-name "dev-portal" \ + --s3-bucket your-lambda-artifacts-bucket-name \ + --capabilities CAPABILITY_NAMED_IAM \ + --parameter-overrides \ + DevPortalSiteS3BucketName="custom-prefix-dev-portal-static-assets" \ + ArtifactsS3BucketName="custom-prefix-dev-portal-artifacts" \ + CognitoDomainNameOrPrefix="custom-prefix" ``` The command will exit when the stack creation is successful. If you'd like to watch it create in real-time, you can log into the cloudformation console. @@ -46,7 +59,8 @@ The command will exit when the stack creation is successful. If you'd like to wa To get the URL for the newly created developer portal instance, find the websiteURL field in the cloudformation console's outputs or run this command: ```bash -aws cloudformation describe-stacks --query "Stacks[?StackName=='dev-portal'][Outputs[?OutputKey=='WebsiteURL']][][].OutputValue" +aws cloudformation describe-stacks --query \ + "Stacks[?StackName=='dev-portal'][Outputs[?OutputKey=='WebsiteURL']][][].OutputValue" ``` You can override any of the parameters in the template using the `--parameter-overrides key="value"` format. This will be necessary if you intend to deploy several instances of the developer portal or customize some of the features. You can see a full list of overridable parameters in `cloudformation/template.yaml` under the `Parameters` section. From 2ac23ae2f5d114876853b453b3abe00c3e84146c Mon Sep 17 00:00:00 2001 From: Alex Chew Date: Wed, 26 Jun 2019 09:12:34 -0700 Subject: [PATCH 5/5] Run `npm install` upon `npm run get-dependencies` --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 9d3b262d1..7c50271cc 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "description": "Serverless Developer Portal for API Gateway", "main": "lambda.js", "scripts": { - "get-dependencies": "npm run get-dev-portal-dependencies && npm run get-lambda-dependencies;", + "get-dependencies": "npm install && npm run get-dev-portal-dependencies && npm run get-lambda-dependencies;", "get-lambda-dependencies": "find lambdas/*/package.json -type f -exec sh -c 'cd $(dirname {}) && npm run get-dependencies' \\;", "get-dev-portal-dependencies": "(cd dev-portal; npm run get-dependencies)", "test": "node scripts/test.js",