@google-cloud/nodejs-common 1.1.1-beta → 1.2.0

package/bin/apps_scripts.sh

@@ -0,0 +1,209 @@
+#!/usr/bin/env bash
+#
+# Copyright 2022 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Const the folder name of Apps Script.
+DEFAULT_APPS_SCRIPT_FOLDER="apps_script"
+
+#######################################
+# Clasp login.
+# Globals:
+#   None
+# Arguments:
+#   None
+#######################################
+clasp_login() {
+  while :; do
+    local claspLogin=$(clasp login --status)
+    if [[ "${claspLogin}" != "You are not logged in." ]]; then
+      printf '%s' "${claspLogin} Would you like to continue with it? [Y/n]"
+      local logout
+      read -r logout
+      logout=${logout:-"Y"}
+      if [[ ${logout} == "Y" || ${logout} == "y" ]]; then
+        break
+      else
+        clasp logout
+      fi
+    fi
+    clasp login --no-localhost
+  done
+}
+
+#######################################
+# Initialize a AppsScript project. Usually it involves following steps:
+# 1. Create a AppsScript project within a new Google Sheet.
+# 2. Prompt to update the Google Cloud Project number of the AppsScript project
+#    to enable external APIs for this AppsScript project.
+# 3. Prompt to grant the access of Cloud Functions' default service account to
+#    this Google Sheet, so the Cloud Functions can query this Sheet later.
+# 4. Initialize the Sheet based on requests.
+# Globals:
+#   None
+# Arguments:
+#   The Google Sheet name.
+#   The folder for Apps Script code, default value ${DEFAULT_APPS_SCRIPT_FOLDER}
+#######################################
+clasp_initialize() {
+  ((STEP += 1))
+  printf '%s\n' "Step ${STEP}: Starting to create Google Sheets..."
+  local sheetName="${1}"
+  local apps_script_src="${2-"${DEFAULT_APPS_SCRIPT_FOLDER}"}"
+  clasp_login
+  while :; do
+    local claspStatus=$(
+      clasp status -P "${apps_script_src}" >/dev/null 2>&1
+      echo $?
+    )
+    if [[ $claspStatus -gt 0 ]]; then
+      clasp create --type sheets --title "${sheetName}" --rootDir "${apps_script_src}"
+      local createResult=$?
+      if [[ $createResult -gt 0 ]]; then
+        printf '%s' "Press any key to continue after you enable the Google \
+Apps Script API: https://script.google.com/home/usersettings..."
+        local any
+        read -n1 -s any
+        printf '\n\n'
+        continue
+      fi
+      break
+    else
+      printf '%s' "AppsScript project exists. Would you like to continue with \
+it? [Y/n]"
+      local useCurrent
+      read -r useCurrent
+      useCurrent=${useCurrent:-"Y"}
+      if [[ ${useCurrent} = "Y" || ${useCurrent} = "y" ]]; then
+        break
+      else
+        printf '%s' "Would you like to delete current AppsScript and create a \
+new one? [N/y]"
+        local deleteCurrent
+        read -r deleteCurrent
+        deleteCurrent=${deleteCurrent:-"N"}
+        if [[ ${deleteCurrent} = "Y" || ${deleteCurrent} = "y" ]]; then
+          rm "${apps_script_src}/.clasp.json"
+          continue
+        fi
+      fi
+    fi
+  done
+}
+
+#######################################
+# Copy GCP project configuration file to AppsScript codes as a constant named
+# `GCP_CONFIG`.
+# Globals:
+#   None
+# Arguments:
+#   The folder for Apps Script code, default value ${DEFAULT_APPS_SCRIPT_FOLDER}
+#######################################
+generate_config_js_for_apps_script() {
+  local apps_script_src="${1-"${DEFAULT_APPS_SCRIPT_FOLDER}"}"
+  local generated_file="${apps_script_src}/.generated_config.js"
+  if [[ -f "${CONFIG_FILE}" ]]; then
+    echo '// Copyright 2022 Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/** @fileoverview Auto-generated configuration file for Apps Script. */
+'>"${generated_file}"
+    echo -n "const GCP_CONFIG = " >>"${generated_file}"
+    cat "${CONFIG_FILE}" >>"${generated_file}"
+  else
+    printf '%s\n' "Couldn't find ${CONFIG_FILE}."
+  fi
+}
+
+#######################################
+# Clasp pushes AppsScript codes.
+# Globals:
+#   None
+# Arguments:
+#   The folder for Apps Script code, default value ${DEFAULT_APPS_SCRIPT_FOLDER}
+#######################################
+clasp_push_codes() {
+  ((STEP += 1))
+  printf '%s\n' "Step ${STEP}: Starting to push codes to the Google Sheets..."
+  local apps_script_src="${1-"${DEFAULT_APPS_SCRIPT_FOLDER}"}"
+  clasp status -P "${apps_script_src}" >>/dev/null
+  local project_status=$?
+  if [[ ${project_status} -gt 0 ]]; then
+    return ${project_status}
+  else
+    generate_config_js_for_apps_script "${apps_script_src}"
+    clasp push --force -P "${apps_script_src}"
+  fi
+}
+
+#######################################
+# Ask user to update the GCP number of this AppsScript.
+# Globals:
+#   GCP_PROJECT
+# Arguments:
+#   The folder for Apps Script code, default value ${DEFAULT_APPS_SCRIPT_FOLDER}
+#######################################
+clasp_update_project_number() {
+  ((STEP += 1))
+  local projectNumber=$(get_project_number)
+  local apps_script_src="${1-"${DEFAULT_APPS_SCRIPT_FOLDER}"}"
+  printf '%s\n' "Step ${STEP}: Update Google Cloud Platform (GCP) Project for \
+Apps Script."
+  printf '%s' "  "
+  clasp open -P "${apps_script_src}"
+  printf '%s\n' "  On the open tab of Apps Script, use 'Project \
+Settings' to set the Google Cloud Platform (GCP) Project as: ${projectNumber}"
+  printf '%s' "Press any key to continue after you update the GCP number..."
+  local any
+  read -n1 -s any
+  printf '\n'
+}
+
+#######################################
+# Ask user to grant the access to CF's default service account.
+# Note: the target GCP needs to have OAuth consent screen.
+# Globals:
+#   SHEET_URL
+# Arguments:
+#   The folder for Apps Script code, default value ${DEFAULT_APPS_SCRIPT_FOLDER}
+#######################################
+grant_access_to_service_account() {
+  ((STEP += 1))
+  local apps_script_src="${1-"${DEFAULT_APPS_SCRIPT_FOLDER}"}"
+  local defaultServiceAccount=$(get_cloud_functions_service_account \
+    "${PROJECT_NAMESPACE}_main")
+  local parentId=$(get_value_from_json_file "${apps_script_src}"/.clasp.json \
+    parentId|cut -d\" -f2)
+  printf '%s\n' "Step ${STEP}: Share the Google Sheet with ${SOLUTION_NAME}."
+
+  printf '%s\n' "  Open Google Sheet: \
+https://drive.google.com/open?id=${parentId}"
+  printf '%s\n' "  Click 'Share' and grant the Viewer access to: \
+${defaultServiceAccount}"
+  printf '%s' "Press any key to continue after you grant the access..."
+  local any
+  read -n1 -s any
+  printf '\n'
+}

package/bin/install_functions.sh

@@ -1043,13 +1043,24 @@ refresh the list:"
 # Globals:
 #   GCP_PROJECT
 # Arguments:
-#   Bucket name var, default value 'GCS_BUCKET'
+#   Bucket name var with optional usage, e.g. 'GCS_BUCKET_REPORT:reports'.
+#     The default value is 'GCS_BUCKET'.
 #   Location var name, default value 'REGION'
 #   If the second location var is unset, use this var as default value
 #######################################
 confirm_located_bucket() {
-  local gcsName defaultValue defaultBucketName locationName location
-  gcsName="${1:-"GCS_BUCKET"}"
+  local gcsName usage defaultValue defaultBucketName locationName location
+  if [[ -z "${1}" ]]; then
+    gcsName="GCS_BUCKET"
+  elif [[ "${1}" == *":"* ]]; then
+    gcsName=$(echo "${1}" | cut -d\: -f1)
+    usage=$(echo "${1}" | cut -d\: -f2)
+    if [[ -n "${usage}" ]]; then
+      usage=" for ${usage}"
+    fi
+  else
+    gcsName="${1}"
+  fi
   locationName="${2:-"REGION"}"
   defaultValue="${!gcsName}"
   defaultBucketName=$(get_default_bucket_name "${GCP_PROJECT}")
@@ -1064,7 +1075,8 @@ confirm_located_bucket() {
 
   (( STEP += 1 ))
   if [[ -z "${location}" ]]; then
-    printf '%s\n' "Step ${STEP}: Checking or creating a Cloud Storage Bucket..."
+    printf '%s\n' "Step ${STEP}: Checking or creating a Cloud Storage \
+Bucket${usage}..."
     if [[ "${locationName}" == "REGION" ]]; then
       select_functions_location ${locationName}
     else
@@ -1072,8 +1084,8 @@ confirm_located_bucket() {
     fi
     location="${!locationName}"
   else
-    printf '%s\n' "Step ${STEP}: Checking or creating a Cloud Storage Bucket in \
-location [${location}] ..."
+    printf '%s\n' "Step ${STEP}: Checking or creating a Cloud Storage \
+Bucket${usage} in location [${location}] ..."
   fi
   declare -g "${locationName}=${location}"
   while :; do
@@ -1474,20 +1486,18 @@ EOF
 "client_id=${client_id}" "scope=${scope}")
     local auth_url
     auth_url="${OAUTH_BASE_URL}auth?${parameters}"
-    printf '%s\n' "3. Open the link in browser and finish authentication: \
-${auth_url}"
+    printf '%s\n' "3. Open the link in your browser and finish authentication. \
+    Do not close the redirected page: ${auth_url}"
     cat <<EOF
   Note:
+    The succeeded OAuth flow will land the browser on an error page - \
+"This site can't be reached". This is expected behavior. Copy the whole URL and continue.
     If the OAuth client is not for a native application, there will be an \
 "Error 400: redirect_uri_mismatch" shown up on the page. In this case, press \
 "Enter" to start again with a native application OAuth client ID.
-    If there is no local web server serving at ${REDIRECT_URI}, the \
-succeeded OAuth flow will land the browser on an error page ("This site can't \
-be reached"). This is an expected behavior. Copy the whole URL and continue.
 
 EOF
-    printf '%s' "4. Copy the authorization code or complete url from browser \
-and paste here: "
+    printf '%s' "4. Copy the complete URL from your browser and paste here: "
     read -r auth_code
     if [[ -z ${auth_code} ]]; then
       printf '%s\n\n' "No authorization code. Starting from beginning again..."
@@ -1679,7 +1689,9 @@ customized_install() {
   local tasks=("$@")
   local task
   for task in "${tasks[@]}"; do
-    ${task}
+    local cmd
+    eval "cmd=(${task})"
+    "${cmd[@]}"
     quit_if_failed $?
   done
 }
@@ -1992,5 +2004,6 @@ join_string_array() {
 _SELF="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 source "${_SELF}/google_ads.sh"
 source "${_SELF}/bigquery.sh"
+source "${_SELF}/apps_scripts.sh"
 
 printf '%s\n' "Common Bash Library is loaded."

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/nodejs-common",
-  "version": "1.1.1-beta",
+  "version": "1.2.0",
   "description": "A NodeJs common library for solutions based on Cloud Functions",
   "author": "Google Inc.",
   "license": "Apache-2.0",
@@ -18,24 +18,23 @@
   "dependencies": {
     "@google-cloud/aiplatform": "^1.19.0",
     "@google-cloud/automl": "^2.5.2",
-    "@google-cloud/bigquery": "^5.12.0",
+    "@google-cloud/bigquery": "^6.0.0",
     "@google-cloud/datastore": "^6.6.2",
     "@google-cloud/firestore": "^5.0.2",
-    "@google-cloud/logging-winston": "^4.2.2",
-    "@google-cloud/pubsub": "^2.19.0",
-    "@google-cloud/storage": "^5.18.3",
-    "@google-cloud/scheduler": "^2.3.0",
-    "gaxios": "^4.3.2",
+    "@google-cloud/logging-winston": "^5.1.0",
+    "@google-cloud/pubsub": "^3.0.1",
+    "@google-cloud/storage": "^6.0.1",
+    "@google-cloud/scheduler": "^3.0.0",
+    "gaxios": "^5.0.0",
     "google-ads-api": "^10.0.1",
     "google-ads-node":"^8.0.1",
-    "google-auth-library": "^7.14.1",
+    "google-auth-library": "^8.0.2",
     "googleapis": "^100.0.0",
-    "soap": "^0.43.0",
     "winston": "^3.7.2",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "jasmine": "^4.0.2"
+    "jasmine": "^4.1.0"
   },
   "scripts": {
     "test": "node node_modules/jasmine/bin/jasmine"