Kvs updates #45

lkdavies · 2024-08-09T20:50:56Z

Issue #, if available: Need to update KVS examples and add examples from CloudFront Developer Guide for parity.
https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/example-function-normalize-query-string.html
https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/example-function-key-value-pairs.html

Description of changes: Deleted verify-jwt directory in favor of kvs-jwt-verify. For kvs-jwt-verify, updated README and test output example, and migrated test-objects directory to kvs-jwt-verify. Added missing README for kvs-conditional-read. Added two new examples with READMEs: kvs-key-value-pairs and normalize-query-string-parameters.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

dbrown-git

I mentioned a few minor changes, but overall this looks good.

dbrown-git · 2024-08-13T17:19:05Z

kvs-jwt-verify/README.md

@@ -2,39 +2,48 @@

 **CloudFront Functions event type: viewer request**

-**Note:** We recommend using the [kvs-jwt-verify example](https://github.com/aws-samples/amazon-cloudfront-functions/tree/main/kvs-jwt-verify) instead. It uses Amazon CloudFront KeyValueStore to store the secret key, and is compatible with JavaScript 2.0 runtime. 
+This function validates a JSON Web Token (JWT) in the query string of the incoming request. It is compatible with JavaScript 2.0 runtime. Using your CloudFront KeyValueStore ID is optional.


This function validates a JSON Web Token (JWT) in the query string of the incoming request. It is compatible with the CloudFront Functions JavaScript 2.0 runtime and uses CloudFront KeyValueStore to store the secret. Using your CloudFront KeyValueStore ID is optional.

dbrown-git · 2024-08-13T17:24:11Z

kvs-jwt-verify/verify-jwt.js


 //Response when JWT is not valid.
 const response401 = {
    statusCode: 401,
    statusDescription: 'Unauthorized'
 };

-// Replace the KVS_ID with your KVS ID
+// (Optional) Replace the KVS_ID with your KVS ID
 const kvsId = "KVS_ID";


If this is not needed, we should just take this out. Making it optional is confusing (to me at least). Maybe just putting a comment in here about remembering to attach the KVS to your function before calling the const kvsKey = 'jwt.secret'

dbrown-git · 2024-08-13T17:26:18Z

kvs-conditional-read/README.md

+
+**CloudFront Functions event type: viewer request**
+
+This example provides a dynamic request URI rewriting mechanism, allowing for A/B testing or gradual rollout of application versions, while also maintaining user stickiness to ensure a consistent experience. It rewrites the request URI based on a configuration stored in CloudFront KeyValueStore. Using your KeyValueStore ID in the code is optional.


I think we should remove the last sentence about storing the KVS ID in the code. I think we should instead just say that you have to create a KVS and put the secret in there and then attach the KVS to the function. I don't quite know the level of detail that we need to go into how to setup KVS for this readme, but if the KVS ID is optional then we should not even mention it since its much easier without it in the code.

dbrown-git · 2024-08-13T17:28:22Z

kvs-key-value-pairs/README.md

+
+**CloudFront Functions event type: viewer request**
+
+The example uses key-value pairs from an Amazon CloudFront [key value store](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/kvs-with-functions.html) in a CloudFront function. 


We should use the formal name of KeyValueStore

dbrown-git · 2024-08-13T17:33:09Z

kvs-key-value-pairs/README.md

+
+The example uses key-value pairs from an Amazon CloudFront [key value store](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/kvs-with-functions.html) in a CloudFront function. 
+
+The example shows a function that uses the content of the URL in the HTTP request to look up a custom path in the key value store. CloudFront then uses that custom path to make the request. This function helps manage the multiple paths that are part of a website. 


I would add an example here. For example, To update the version of a blog platform on a website. The old blog has origin path /blog-v1 while the new blog has origin path /blog-v2. This function can lookup the URL path of the incoming request and rewrite the URL path (/blog-v1) to the new version of the blog (/blog-v2).

dbrown-git · 2024-08-13T17:33:53Z

kvs-key-value-pairs/README.md

+
+The example shows a function that uses the content of the URL in the HTTP request to look up a custom path in the key value store. CloudFront then uses that custom path to make the request. This function helps manage the multiple paths that are part of a website. 
+
+The example works with JavaScript runtime 2.0. The CloudFront KeyValueStore ID is optional.


Again, I would take out the KVS ID is optional and replace it with some commentary on attaching a KVS to the function. Also do we want to link to the 2.0 runtime in our public docs?

dbrown-git · 2024-08-13T17:35:08Z

kvs-key-value-pairs/kvs-key-value-pairs.js

@@ -0,0 +1,27 @@
+import cf from 'cloudfront';
+
+// (Optional) Declare the ID of the key value store that you have associated with this function


I would remove this and replace it with a comment about remembering to attach the KVS to your function before referencing KVS in your code.

dbrown-git · 2024-08-13T17:35:32Z

kvs-key-value-pairs/kvs-key-value-pairs.js

+
+// (Optional) Declare the ID of the key value store that you have associated with this function
+
+const kvsId = "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111";


If we put in a comment about referencing/attaching KVS to your function then we can remove this line.

dbrown-git · 2024-08-13T17:36:28Z

kvs-key-value-pairs/kvs-key-value-pairs.js

+
+const kvsId = "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111";
+
+const kvsHandle = cf.kvs(kvsId);


Is this needed if we aren't defining the KVS ID?

dbrown-git

Copy text looks good but I see a couple of issues with the code samples that need to be fixed.

dbrown-git · 2024-08-19T21:51:19Z

kvs-key-value-pairs/kvs-key-value-pairs.js

+    try {
+        // Replace the first path of the pathname with the value of the key
+        // For example http(s)://domain/<value>/something/else
+        pathSegments[1] = await kvsHandle.get(key);


You're not defining kvsHandle anywhere so this function would get an error. You need something like this:
const kvsHandle = cf.kvs(); outside the function handler.

dbrown-git · 2024-08-19T21:55:06Z

kvs-jwt-verify/verify-jwt.js


 //Response when JWT is not valid.
 const response401 = {
    statusCode: 401,
    statusDescription: 'Unauthorized'
 };

-// Replace the KVS_ID with your KVS ID
-const kvsId = "KVS_ID";


You remove the KVS_ID from the code, but its still referenced in live 131. You will also need to remove it from line 131.

dbrown-git

Changes looks good. Approved.

lkdavies added 16 commits August 9, 2024 13:06

Create README.md

332876c

Update verify-jwt.js

04d3d50

Update ABUriMappingFunction.js

b137bd6

Create expired-jwt.json

6577620

Rename invalid-jwt.json to invalid-jwt.json

cb68a21

Rename invalid-nbe-jwt.json to invalid-nbe-jwt.json

5fecae3

Rename missing-jwt.json to missing-jwt.json

ba0fc7c

Rename valid-jwt.json to valid-jwt.json

ec26de2

Delete verify-jwt directory

aebcaa8

Create normalize-query-string.js

c9f864f

Create README.md

9e85f34

Create kvs-key-value-pairs.js

ce8899c

Create README.md

920ecfb

Create README.md

ce1542f

Update README.md

46c76b4

Update README.md

b89dd05

dbrown-git reviewed Aug 13, 2024

View reviewed changes

lkdavies added 6 commits August 13, 2024 11:12

Update README.md

23125bb

Update README.md

4a3c686

Update verify-jwt.js

85732aa

Update README.md

d1561f6

Update kvs-key-value-pairs.js

0289868

Update kvs-key-value-pairs.js

faa87f9

dbrown-git reviewed Aug 19, 2024

View reviewed changes

lkdavies added 5 commits August 19, 2024 15:08

Update kvs-key-value-pairs.js

bfb6668

Update verify-jwt.js

4adcdc3

Update verify-jwt.js

257053b

Update verify-jwt.js

b71db44

Update kvs-key-value-pairs.js

c12a682

dbrown-git approved these changes Aug 20, 2024

View reviewed changes

lkdavies merged commit b7511cd into main Aug 20, 2024

lkdavies deleted the KVS-updates branch August 20, 2024 17:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Kvs updates #45

Kvs updates #45

Uh oh!

lkdavies commented Aug 9, 2024

Uh oh!

dbrown-git left a comment

Uh oh!

dbrown-git Aug 13, 2024

Uh oh!

dbrown-git Aug 13, 2024

Uh oh!

dbrown-git Aug 13, 2024

Uh oh!

dbrown-git Aug 13, 2024

Uh oh!

dbrown-git Aug 13, 2024

Uh oh!

dbrown-git Aug 13, 2024

Uh oh!

dbrown-git Aug 13, 2024

Uh oh!

dbrown-git Aug 13, 2024

Uh oh!

dbrown-git Aug 13, 2024

Uh oh!

dbrown-git left a comment

Uh oh!

dbrown-git Aug 19, 2024

Uh oh!

dbrown-git Aug 19, 2024

Uh oh!

dbrown-git left a comment

Uh oh!

Uh oh!


		CloudFront Functions event type: viewer request

		This example provides a dynamic request URI rewriting mechanism, allowing for A/B testing or gradual rollout of application versions, while also maintaining user stickiness to ensure a consistent experience. It rewrites the request URI based on a configuration stored in CloudFront KeyValueStore. Using your KeyValueStore ID in the code is optional.


		CloudFront Functions event type: viewer request

		The example uses key-value pairs from an Amazon CloudFront [key value store](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/kvs-with-functions.html) in a CloudFront function.


		The example uses key-value pairs from an Amazon CloudFront [key value store](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/kvs-with-functions.html) in a CloudFront function.

		The example shows a function that uses the content of the URL in the HTTP request to look up a custom path in the key value store. CloudFront then uses that custom path to make the request. This function helps manage the multiple paths that are part of a website.


		The example shows a function that uses the content of the URL in the HTTP request to look up a custom path in the key value store. CloudFront then uses that custom path to make the request. This function helps manage the multiple paths that are part of a website.

		The example works with JavaScript runtime 2.0. The CloudFront KeyValueStore ID is optional.

		@@ -0,0 +1,27 @@
		import cf from 'cloudfront';

		// (Optional) Declare the ID of the key value store that you have associated with this function


		// (Optional) Declare the ID of the key value store that you have associated with this function

		const kvsId = "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111";


		const kvsId = "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111";

		const kvsHandle = cf.kvs(kvsId);

Kvs updates #45

Kvs updates #45

Uh oh!

Conversation

lkdavies commented Aug 9, 2024

Uh oh!

dbrown-git left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dbrown-git left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dbrown-git left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!