Address comments from PR review.

hamadise · hamadise · commit 03592417168c · 2025-03-04T03:27:19.000Z
diff --git a/apps-script/incident-response/ChatApi.gs b/apps-script/incident-response/ChatApi.gs
@@ -14,17 +14,20 @@
  * limitations under the License.
  */
 /**
- * Creates a space in Google Chat with the provided title and members, and posts an
- * initial message to it.
+ * Handles an incident by creating a chat space, adding members, and posting a message.
+ * Uses either application credentials or human credentials based on the formData.
  *
- * @param {Object} formData the data submitted by the user. It should contain the fields
- *                          title, description, and users.
- * @return {string} the resource name of the new space.
+ * @param {Object} formData - The data submitted by the user. It should contain the fields:
+ *                           - title: The display name of the chat space.
+ *                           - description: The description of the incident.
+ *                           - users: A comma-separated string of user emails to be added to the space.
+ *                           - isAppCredentials: Boolean indicating whether to use application credentials.
+ * @return {string} The resource name of the new space.
  */
 function handleIncident(formData) {
   console.log(formData)
-  const appCredentialsMode = formData.appCredentials; // Get the appCredentials element
-  if(appCredentialsMode){
+  const isAppCredentials = formData.isAppCredentials; // Get the isAppCredentials element
+  if(isAppCredentials){
     return handleIncidentWithAppCredentials(formData)
   } else{
     return handleIncidentWithHumanCredentials(formData)
diff --git a/apps-script/incident-response/ChatApiAppCredentials.gs b/apps-script/incident-response/ChatApiAppCredentials.gs
@@ -13,32 +13,48 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+// [START handle_incident_with_application_credentials]
 
+/**
+ * Handles an incident by creating a chat space, adding members, and posting a message.
+ * All the actions are done using application credentials.
+ *
+ * @param {Object} formData - The data submitted by the user. It should contain the fields:
+ *                           - title: The display name of the chat space.
+ *                           - description: The description of the incident.
+ *                           - users: A comma-separated string of user emails to be added to the space.
+ * @return {string} The resource name of the new space.
+ */
 function handleIncidentWithAppCredentials(formData) {
   const users = formData.users.trim().length > 0 ? formData.users.split(',') : [];
-  const spaceName = createChatSpaceWithAppCredentials(formData.title);
-  createHumanMembershipWithAppCredentials(spaceName, getUserEmail());
+  const service = _getService();
+  if (!service.hasAccess()) {
+      console.error(service.getLastError());
+      return;
+   }
+  const spaceName = _createChatSpaceWithAppCredentials(formData.title, service);
+  _createHumanMembershipWithAppCredentials(spaceName, getUserEmail(),service);
   for (const user of users ){
-    createHumanMembershipWithAppCredentials(spaceName, user);
+    _createHumanMembershipWithAppCredentials(spaceName, user, service);
   }
-  createMessageWithAppCredentials(spaceName, formData.description);
+  _createMessageWithAppCredentials(spaceName, formData.description, service);
   return spaceName;
 }
 
-
-
-function createChatSpaceWithAppCredentials(spaceName) {
+/**
+ * Creates a chat space with application credentials.
+ *
+ * @param {string} displayName - The name of the chat space.
+ * @param {object} service - The credentials of the service account.
+ * @returns {string} The resource name of the new space.
+ */
+function _createChatSpaceWithAppCredentials(displayName, service) {
   try {
-    const service = getService_();
-    if (!service.hasAccess()) {
-      console.error(service.getLastError());
-      return;
-    }
     // for private apps, the alias can be used
     const my_customer_alias = "customers/my_customer"
     // Specify the space to create.
     const space = {
-        displayName: spaceName,
+        displayName: displayName,
         spaceType: 'SPACE',                
         customer: my_customer_alias
     };
@@ -56,8 +72,15 @@ function createChatSpaceWithAppCredentials(spaceName) {
     console.log('Failed to create space with error %s', err.message);
   }
 }
-
-function createMessageWithAppCredentials(spaceName, message) {
+ /*
+ * Creates a chat message with application credentials.
+ *
+ * @param {string} spaceName - The resource name of the space.
+ * @param {string} message - The text to be posted.
+ * @param {object} service - The credentials of the service account.
+ * @return {string} the resource name of the new space.
+ */
+function _createMessageWithAppCredentials(spaceName, message, service) {
   try {
     const service = getService_();
     if (!service.hasAccess()) {
@@ -80,8 +103,14 @@ function createMessageWithAppCredentials(spaceName, message) {
     console.log('Failed to create message with error %s', err.message);
   }
 }
-
-function createHumanMembershipWithAppCredentials(spaceName, email){
+/**
+ * Creates a human membership in a chat space with application credentials.
+ *
+ * @param {string} spaceName - The resource name of the space.
+ * @param {string} email - The email of the user to be added.
+ * @param {object} service - The credentials of the service account.
+ */
+function _createHumanMembershipWithAppCredentials(spaceName, email, service){
   try{
     const service = getService_();
       if (!service.hasAccess()) {
@@ -90,7 +119,6 @@ function createHumanMembershipWithAppCredentials(spaceName, email){
       }
     const membership = {
       member: {
-        // TODO(developer): Replace USER_NAME here
         name: 'users/'+email,
         // User type for the membership
         type: 'HUMAN'
@@ -109,13 +137,17 @@ function createHumanMembershipWithAppCredentials(spaceName, email){
 
 }
 
-
-function getService_() {
+ /*
+ * Creates a service for the service account.
+ * @return {object}  - The credentials of the service account.
+ */
+function _getService() {
   return OAuth2.createService(APP_CREDENTIALS.client_email)
       .setTokenUrl('https://oauth2.googleapis.com/token')
       .setPrivateKey(APP_CREDENTIALS.private_key)
       .setIssuer(APP_CREDENTIALS.client_email)
       .setSubject(APP_CREDENTIALS.client_email)
       .setScope(APP_CREDENTIALS_SCOPES)
       .setPropertyStore(PropertiesService.getScriptProperties());
-}
+}
+// [END handle_incident_with_application_credentials]
diff --git a/apps-script/incident-response/ChatApiHumanCredentials.gs b/apps-script/incident-response/ChatApiHumanCredentials.gs
@@ -13,21 +13,23 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-// [START chat_incident_response_space_creator]
+// [START handle_incident_with_human_credentials]
 
 /**
- * Creates a space in Google Chat with the provided title and members, and posts an
- * initial message to it.
+ * Handles an incident by creating a chat space, adding members, and posting a message.
+ * All the actions are done using human credentials.
  *
- * @param {Object} formData the data submitted by the user. It should contain the fields
- *                          title, description, and users.
- * @return {string} the resource name of the new space.
+ * @param {Object} formData - The data submitted by the user. It should contain the fields:
+ *                           - title: The display name of the chat space.
+ *                           - description: The description of the incident.
+ *                           - users: A comma-separated string of user emails to be added to the space.
+ * @return {string} The resource name of the new space.
  */
 function handleIncidentWithHumanCredentials(formData) {
   const users = formData.users.trim().length > 0 ? formData.users.split(',') : [];
-  const spaceName = setUpSpaceWithHumanCredentials(formData.title, users);
-  addAppToSpaceWithHumanCredentials(spaceName);
-  createMessageWithHumanCredentials(spaceName, formData.description);
+  const spaceName = _setUpSpaceWithHumanCredentials(formData.title, users);
+  _addAppToSpaceWithHumanCredentials(spaceName);
+  _createMessageWithHumanCredentials(spaceName, formData.description);
   return spaceName;
 }
 
@@ -36,7 +38,7 @@ function handleIncidentWithHumanCredentials(formData) {
  *
  * @return {string} the resource name of the new space.
  */
-function setUpSpaceWithHumanCredentials(displayName, users) {
+function _setUpSpaceWithHumanCredentials(displayName, users) {
   const memberships = users.map(email => ({
     member: {
       name: `users/${email}`,
@@ -61,7 +63,7 @@ function setUpSpaceWithHumanCredentials(displayName, users) {
  *
  * @return {string} the resource name of the new membership.
  */
-function addAppToSpaceWithHumanCredentials(spaceName) {
+function _addAppToSpaceWithHumanCredentials(spaceName) {
   const request = {
     member: {
       name: "users/app",
@@ -78,13 +80,12 @@ function addAppToSpaceWithHumanCredentials(spaceName) {
  *
  * @return {string} the resource name of the new message.
  */
-function createMessageWithHumanCredentials(spaceName, text) {
+function _createMessageWithHumanCredentials(spaceName, text) {
   const request = {
     text: text
   };
   // Call Chat API method spaces.messages.create
   const message = Chat.Spaces.Messages.create(request, spaceName);
   return message.name;
 }
-
-// [END chat_incident_response_space_creator]
+// [END handle_incident_with_human_credentials]
diff --git a/apps-script/incident-response/ChatApp.gs b/apps-script/incident-response/ChatApp.gs
@@ -185,5 +185,4 @@ function getUserDisplayName_(userMap, userName) {
   userMap.set(userName, displayName);
   return displayName;
 }
-
 // [END chat_incident_response_app]
diff --git a/apps-script/incident-response/Consts.gs b/apps-script/incident-response/Consts.gs
@@ -15,11 +15,9 @@
  */
 // [START chat_incident_response_consts]
 
-const PROJECT_ID = PROJECT_ID';
+const PROJECT_ID = 'replace-with-your-project-id';
 const CLOSE_INCIDENT_COMMAND_ID = 3;
-const APP_CREDENTIALS = APP_CREDENTIALS;
+const APP_CREDENTIALS = 'replace-with-your-app-credentials';
 const APP_CREDENTIALS_SCOPES = 'https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.app.spaces.create';
-const GEMINI_API_KEY = GEMINI_API_KEY;
-
-
+const GEMINI_API_KEY = 'replace-with-your-gemini-api-key';
 // [END chat_incident_response_consts]
diff --git a/apps-script/incident-response/DocsApi.gs b/apps-script/incident-response/DocsApi.gs
@@ -36,5 +36,4 @@ function createDoc_(title, resolution, chatHistory, chatSummary) {
   body.appendParagraph(chatHistory);
   return doc.getUrl();
 }
-
-// [END chat_incident_response_docs]
+// [END chat_incident_response_docs]
diff --git a/apps-script/incident-response/GeminiApi.gs b/apps-script/incident-response/GeminiApi.gs
@@ -16,7 +16,7 @@
 // [START chat_incident_response_gemini]
 
 /**
- * Summarizes a Chat conversation using the Vertex AI text prediction API.
+ * Summarizes a Chat conversation using the Gemini API text prediction API.
  *
  * @param {string} chatHistory The Chat history that will be summarized.
  * @return {string} The content from the text prediction response.
@@ -62,5 +62,4 @@ function summarizeChatHistory_(chatHistory) {
     return 'Gemini API error, please check logs.'
   }
 }
-
 // [END chat_incident_response_gemini]
diff --git a/apps-script/incident-response/Index.html b/apps-script/incident-response/Index.html
@@ -47,7 +47,7 @@ <h1>Incident Manager</h1>
             </p>
             <p>
               <label for="appCredentials">Use app credentials</label>
-              <input type="checkbox" id="appCredentials" name="appCredentials" value="true">
+              <input type="checkbox" id="isAppCredentials" name="isAppCredentials" value="true">
             </p>
             <p class="text-center">
               <input type="submit" value="CREATE CHAT SPACE" />
diff --git a/apps-script/incident-response/README.md b/apps-script/incident-response/README.md
@@ -91,7 +91,7 @@ the following APIs:
 ### 4. Create API key
 
 To use Gemini API, you need to have an API key created:
-1. In the Google Cloud ocnsole, click **Menu** > **APIs & Services** > **Credentials**
+1. In the Google Cloud console, click **Menu** > **APIs & Services** > **Credentials**
 1. Click **CREATE CRENDETIALAS**, then select **API key**.
 1. Create the key
 
@@ -110,7 +110,7 @@ replace placeholder information with real information.
 To learn more about authentication in Google Chat, see [Authenticate and authorize
 Chat apps and Google Chat API requests](https://developers.devsite.corp.google.com/chat/api/guides/auth).
 
-#### 4.1 Authenticate as a user configuration
+#### 4.1 Set up authentication as a user 
 
 1. In the Google Cloud console, go to **Menu** > **APIs & Services** >
    [**OAuth consent screen**](https://console.cloud.google.com/apis/credentials/consent).
@@ -136,11 +136,11 @@ Chat apps and Google Chat API requests](https://developers.devsite.corp.google.c
 1. Click **Save and Continue**.
 1. Review the app registration summary, then click **Back to Dashboard**.
 
-#### 4.2 Authenticate as a app configuration
+#### 4.2 Set up authentication as an app
 
 This is available in [Developer Preview](/workspace/preview) only.
 
-##### 4.2.1 setup service account and key
+##### 4.2.1 Setup service account and key
 
 1. In the Google Cloud console, go to **Menu*  > **IAM & Admin** > **Service Accounts**
 1. Click **Create service account**.
@@ -157,6 +157,10 @@ This is available in [Developer Preview](/workspace/preview) only.
    1. Select **JSON**, then click **Create**.
    1. Click **Close**.
 
+**Warning**: This example uses an exported service account key for simplicity's sake. Exporting a private key is not recommended 
+in production because it shouldn't be stored in an insecure location, such as source control. To learn more about secure service account 
+implementations and best practices, see Choose when to use service accounts.
+
 ##### 4.2.2 Receive administrator approval
 
 To use an authorization scope that begins with
@@ -192,12 +196,6 @@ After that, the Chap app should be configured in **Goolge Workspace Marketplace
   1. Under **Developer information**, enter your **Developer name**, **Developer website URL**, and **Developer email**.
   1. Click **Save draft**
   1. [Set up authorization Chat app](https://support.google.com/a?p=chat-app-auth).
-
-**Warning**: This example uses an exported service account key for simplicity's sake. Exporting a private key is not recommended 
-in production because it shouldn't be stored in an insecure location, such as source control. To learn more about secure service account 
-implementations and best practices, see Choose when to use service accounts.
-
-
 ### 5. Create an Apps Script project and connect it to the Google Cloud project
 
 Before creating the Apps Script project, copy your Google Cloud project number.
@@ -293,6 +291,7 @@ The Chat app is ready to respond to messages.
 
 Navigate to the **Web app URL** from the Apps Script deployment to test your app.
 
-#### 8.1 app auth mode
-If the checkbox is selected, the Chat app will use app authentication to create the space, add members and post the message to the space.
-If the checkbox is not selected, the Chat app will use human credentials instead and all the actions will be done on behalf of the user.
+#### 8.1. Select the authentication mode
+
+If the checkbox 'Use app credentials' is selected, the Chat app will use app authentication to create the space, add members and post the message to the space.
+If the checkbox is not selected, the Chat app will use user credentials instead and all the actions will be done on behalf of the user.
diff --git a/apps-script/incident-response/appsscript.json b/apps-script/incident-response/appsscript.json
@@ -8,6 +8,11 @@
           "userSymbol": "Chat",
           "serviceId": "chat",
           "version": "v1"
+        },
+        {
+          "userSymbol": "AdminDirectory",
+          "version": "directory_v1",
+          "serviceId": "admin"
         }
       ],
       "libraries": [

Original file line number	Diff line number	Diff line change
`@@ -185,5 +185,4 @@ function getUserDisplayName_(userMap, userName) {`
`185`	`185`	`userMap.set(userName, displayName);`
`186`	`186`	`return displayName;`
`187`	`187`	`}`
`188`		`-`
`189`	`188`	`// [END chat_incident_response_app]`
Original file line number	Diff line number	Diff line change
`@@ -36,5 +36,4 @@ function createDoc_(title, resolution, chatHistory, chatSummary) {`
`36`	`36`	`body.appendParagraph(chatHistory);`
`37`	`37`	`return doc.getUrl();`
`38`	`38`	`}`
`39`		`-`
`40`		`-// [END chat_incident_response_docs]`
	`39`	`+// [END chat_incident_response_docs]`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`// [START chat_incident_response_gemini]`
`17`	`17`
`18`	`18`	`/**`
`19`		`- * Summarizes a Chat conversation using the Vertex AI text prediction API.`
	`19`	`+ * Summarizes a Chat conversation using the Gemini API text prediction API.`
`20`	`20`	`*`
`21`	`21`	`* @param {string} chatHistory The Chat history that will be summarized.`
`22`	`22`	`* @return {string} The content from the text prediction response.`
`@@ -62,5 +62,4 @@ function summarizeChatHistory_(chatHistory) {`
`62`	`62`	`return 'Gemini API error, please check logs.'`
`63`	`63`	`}`
`64`	`64`	`}`
`65`		`-`
`66`	`65`	`// [END chat_incident_response_gemini]`