DOCSP-32718: add CodeWhisperer comments to transactions code snippets #769

ccho-mongodb · 2023-08-30T16:16:45Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-32718
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/node/docsworker-xlarge/DOCSP-32718-transactions/fundamentals/transactions/

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?

jordan-smith721

LGTM after removing the period from shorter single-line comments

jordan-smith721 · 2023-09-01T20:41:56Z

source/code-snippets/transactions/txn-core.js

@@ -1,12 +1,12 @@
 const { MongoError, MongoClient } = require('mongodb');

-// drop collections
+// Drop the "customers", "inventory", and "orders" collections from the "testdb" database.


Suggested change

// Drop the "customers", "inventory", and "orders" collections from the "testdb" database.

// Drop the "customers", "inventory", and "orders" collections from the "testdb" database

jordan-smith721 · 2023-09-01T20:42:36Z

source/code-snippets/transactions/txn-core.js

    console.log('Unable to insert test data: ' + e);
  }
 }

+// Print all documents in the "customers", "inventory", and "orders" collections.


Suggested change

// Print all documents in the "customers", "inventory", and "orders" collections.

// Print all documents in the "customers", "inventory", and "orders" collections

jordan-smith721 · 2023-09-01T20:43:21Z

source/code-snippets/transactions/txn-core.js

    await session.endSession();
  }
 }
 // end placeOrder

+
+// Run the full transaction example.


Suggested change

// Run the full transaction example.

// Run the full transaction example

jordan-smith721 · 2023-09-01T20:43:42Z

source/code-snippets/transactions/txn-core.js

    } else {
      console.log('An error occured in the transaction, performing a data rollback:' + error);
    }
+    // End the transaction without making the updates performed in the session.


Suggested change

// End the transaction without making the updates performed in the session.

// End the transaction without making the updates performed in the session

jordan-smith721 · 2023-09-01T20:43:49Z

source/code-snippets/transactions/txn-core.js

    await session.abortTransaction();
  } finally {
+    // End the transaction making all the changes performed in the session.


Suggested change

// End the transaction making all the changes performed in the session.

// End the transaction making all the changes performed in the session

jordan-smith721 · 2023-09-01T20:45:50Z

source/code-snippets/transactions/txn-core.js

  const payment = { customer: 98765, total: 37.17 };

  try {
+    // Call the method that updates the customer and inventory in a transaction.


Suggested change

// Call the method that updates the customer and inventory in a transaction.

// Call the method that updates the customer and inventory in a transaction

jordan-smith721 · 2023-09-01T20:45:57Z

source/code-snippets/transactions/txn-core.js

    await placeOrder(client, cart, payment);
  } finally {
+    // Call a method that removes data from prior runs of this example.


Suggested change

// Call a method that removes data from prior runs of this example.

// Call a method that removes data from prior runs of this example

jordan-smith721 · 2023-09-01T20:46:21Z

source/code-snippets/transactions/txn-core.js

@@ -86,47 +101,68 @@ async function placeOrder(client, cart, payment) {
    }

    const customerCollection = client.db('testdb').collection('customers');
+
+    // Within the session, add the order details to the "orders" array of the customer document.


Suggested change

// Within the session, add the order details to the "orders" array of the customer document.

// Within the session, add the order details to the "orders" array of the customer document

jordan-smith721 · 2023-09-01T20:46:28Z

source/code-snippets/transactions/txn-core.js

      if (checkInventory === null) {
        throw new Error('Insufficient quantity or SKU not found.');
      }

+      // Decrement the inventory of the item by the amount specified in the order.


Suggested change

// Decrement the inventory of the item by the amount specified in the order.

// Decrement the inventory of the item by the amount specified in the order

jordan-smith721 · 2023-09-01T20:46:32Z

source/code-snippets/transactions/txn-core.js

      const checkInventory = await inventoryCollection.findOne(
        {
          sku: item.sku,
          qty: { $gte: item.qty }
        },
        { session }
      )
+      // Throw an exception if the item lacks sufficient quantity or SKU does not exist.


Suggested change

// Throw an exception if the item lacks sufficient quantity or SKU does not exist.

// Throw an exception if the item lacks sufficient quantity or SKU does not exist

…#769) * DOCSP-32718: add CodeWhisperer comments to transactions code snippets (cherry picked from commit 4db5c08)

…mongodb#769) * DOCSP-32718: add CodeWhisperer comments to transactions code snippets

Chris Cho added 5 commits August 30, 2023 12:15

DOCSP-32718: add CodeWhisperer comments to transactions code snippets

f81576e

build

160a2d7

fix highlighting

026c6d4

build again

90c3d6c

remove extra lines

ab8d6fa

jordan-smith721 approved these changes Sep 1, 2023

View reviewed changes

Chris Cho added 3 commits September 5, 2023 16:28

PRR fixes

e6a25c7

reword

f3ea0c0

update highlighted lines

9643564

ccho-mongodb merged commit 4db5c08 into mongodb:master Sep 5, 2023

ccho-mongodb deleted the DOCSP-32718-transactions branch September 5, 2023 21:52

ccho-mongodb pushed a commit that referenced this pull request Sep 8, 2023

DOCSP-32718: add CodeWhisperer comments to transactions code snippets (…

69040b3

…#769) * DOCSP-32718: add CodeWhisperer comments to transactions code snippets (cherry picked from commit 4db5c08)

mongoKart pushed a commit to mongoKart/docs-node that referenced this pull request Nov 3, 2023

DOCSP-32718: add CodeWhisperer comments to transactions code snippets (…

418a6d5

…mongodb#769) * DOCSP-32718: add CodeWhisperer comments to transactions code snippets

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

DOCSP-32718: add CodeWhisperer comments to transactions code snippets #769

DOCSP-32718: add CodeWhisperer comments to transactions code snippets #769

Uh oh!

ccho-mongodb commented Aug 30, 2023 •

edited

Loading

Uh oh!

jordan-smith721 left a comment

Uh oh!

jordan-smith721 Sep 1, 2023

Uh oh!

jordan-smith721 Sep 1, 2023

Uh oh!

jordan-smith721 Sep 1, 2023

Uh oh!

jordan-smith721 Sep 1, 2023

Uh oh!

jordan-smith721 Sep 1, 2023

Uh oh!

jordan-smith721 Sep 1, 2023

Uh oh!

jordan-smith721 Sep 1, 2023

Uh oh!

jordan-smith721 Sep 1, 2023

Uh oh!

jordan-smith721 Sep 1, 2023

Uh oh!

jordan-smith721 Sep 1, 2023

Uh oh!

Uh oh!

	// Drop the "customers", "inventory", and "orders" collections from the "testdb" database.
	// Drop the "customers", "inventory", and "orders" collections from the "testdb" database

	// Print all documents in the "customers", "inventory", and "orders" collections.
	// Print all documents in the "customers", "inventory", and "orders" collections

	// Run the full transaction example.
	// Run the full transaction example

	// End the transaction without making the updates performed in the session.
	// End the transaction without making the updates performed in the session

	// End the transaction making all the changes performed in the session.
	// End the transaction making all the changes performed in the session

	// Call the method that updates the customer and inventory in a transaction.
	// Call the method that updates the customer and inventory in a transaction

	// Call a method that removes data from prior runs of this example.
	// Call a method that removes data from prior runs of this example

	// Within the session, add the order details to the "orders" array of the customer document.
	// Within the session, add the order details to the "orders" array of the customer document

	// Decrement the inventory of the item by the amount specified in the order.
	// Decrement the inventory of the item by the amount specified in the order

	// Throw an exception if the item lacks sufficient quantity or SKU does not exist.
	// Throw an exception if the item lacks sufficient quantity or SKU does not exist

DOCSP-32718: add CodeWhisperer comments to transactions code snippets #769

DOCSP-32718: add CodeWhisperer comments to transactions code snippets #769

Uh oh!

Conversation

ccho-mongodb commented Aug 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Self-Review Checklist

Uh oh!

jordan-smith721 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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ccho-mongodb commented Aug 30, 2023 •

edited

Loading