@google-cloud/nodejs-common 2.4.3 → 2.4.4

package/README.md

@@ -12,7 +12,8 @@ and [Data Tasks Coordinator]. This library includes:
    for [GMP and Google Ads Connector]:
 
    - Google Analytics data import
-   - Google Analytics measurement protocol
+   - ~~Google Analytics measurement protocol~~ (This has
+ been deprecated since v2.4.4.)
    - Campaign Manager offline conversion upload
    - Search Ads 360 conversions upload
    - Google Ads click conversions upload

package/bin/install_functions.sh

@@ -15,7 +15,7 @@
 # limitations under the License.
 
 # Cloud Functions Runtime Environment.
-CF_RUNTIME="${CF_RUNTIME:=nodejs18}"
+CF_RUNTIME="${CF_RUNTIME:=nodejs20}"
 CF_MEMORY="${CF_MEMORY:=2048MB}"
 
 # Counter for steps.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/nodejs-common",
-  "version": "2.4.3",
+  "version": "2.4.4",
   "description": "A NodeJs common library for solutions based on Cloud Functions",
   "author": "Google Inc.",
   "license": "Apache-2.0",
@@ -16,26 +16,25 @@
   },
   "homepage": "https://github.com/GoogleCloudPlatform/cloud-for-marketing/blob/master/marketing-analytics/activation/common-libs/nodejs-common/README.md",
   "dependencies": {
-    "@google-cloud/aiplatform": "^3.34.0",
-    "@google-cloud/automl": "^4.0.1",
-    "@google-cloud/bigquery": "^7.9.1",
+    "@google-cloud/aiplatform": "3.35.0",
+    "@google-cloud/automl": "4.0.1",
+    "@google-cloud/bigquery": "^7.9.4",
     "@google-cloud/datastore": "^9.2.1",
-    "@google-cloud/firestore": "^7.10.0",
+    "@google-cloud/firestore": "^7.11.0",
     "@google-cloud/logging-winston": "^6.0.0",
-    "@google-cloud/pubsub": "^4.9.0",
-    "@google-cloud/storage": "^7.14.0",
-    "@google-cloud/scheduler": "^4.3.0",
-    "@google-cloud/secret-manager": "^5.6.0",
+    "@google-cloud/pubsub": "4.11.0",
+    "@google-cloud/secret-manager": "5.6.0",
+    "@google-cloud/scheduler": "4.3.0",
+    "@google-cloud/storage": "^7.16.0",
+    "@grpc/grpc-js": "^1.13.3",
     "gaxios": "^6.7.1",
-    "google-ads-nodejs-client": "^18.0.1",
-    "google-auth-library": "^9.15.0",
-    "googleapis": "^144.0.0",
-    "winston": "^3.17.0",
-    "@grpc/grpc-js": "^1.12.2",
-    "lodash": "^4.17.21"
+    "google-ads-nodejs-client": "18.0.1",
+    "googleapis": "^148.0.0",
+    "lodash": "^4.17.21",
+    "winston": "^3.17.0"
   },
   "devDependencies": {
-    "jasmine": "^5.2.0"
+    "jasmine": "^5.7.0"
   },
   "scripts": {
     "test": "node node_modules/jasmine/bin/jasmine"

package/src/apis/index.js

@@ -47,18 +47,6 @@ exports.displayvideo = require('./display_video.js');
  */
 exports.analytics = require('./analytics.js');
 
-/**
- * APIs integration class for Google Analytics Measurement Protocol.
- * @const {{MeasurementProtocol:!MeasurementProtocol}}
- */
-exports.measurementprotocol = require('./measurement_protocol.js');
-
-/**
- * Cloud Resource Manager for checking the permissions.
- * @const {{CloudPlatformApis:!CloudPlatformApis}}
- */
-exports.cloudplatform = require('./cloud_platform_apis.js');
-
 /**
  * APIs integration class for Google Spreadsheets.
  * @const {{

package/src/apis/cloud_platform_apis.js

@@ -1,96 +0,0 @@
-// Copyright 2019 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 API handler for Google Cloud Platform APIs.
- */
-
-'use strict';
-
-const {google} = require('googleapis');
-const AuthClient = require('./auth_client.js');
-
-const API_SCOPES = Object.freeze([
-  'https://www.googleapis.com/auth/cloud-platform',
-]);
-const API_VERSION = 'v1';
-
-/**
- * Google Cloud Platform API stubs. This class offers convenient request
- * wrappers for some of Google Cloud APIs that are not supported by
- * Google cloud client libraries.
- */
-class CloudPlatformApis {
-  constructor(env = process.env) {
-    /** @const {!AuthClient} */
-    this.authClient = new AuthClient(API_SCOPES, env);
-    this.projectId = env['GCP_PROJECT'];
-  }
-
-  /**
-   * Gets the auth object.
-   * @return {!Promise<{!OAuth2Client|!JWT|!Compute}>}
-   */
-  async getAuth_() {
-    if (this.auth) return this.auth;
-    await this.authClient.prepareCredentials();
-    this.auth = this.authClient.getDefaultAuth();
-    return this.auth;
-  }
-
-  /**
-   * Gets the GCP project Id. In Cloud Functions, it *should* be passed in
-   * through environment variable during the deployment. But if it doesn't exist
-   * (for example, in local unit tests), this function will fallback to ADC
-   * (Application Default Credential) auth's asynchronous function to get the
-   * project Id.
-   * @return {string}
-   * @private
-   */
-  async getProjectId_() {
-    if (!this.projectId) this.projectId = await this.auth.getProjectId();
-    return this.projectId;
-  }
-
-  /**
-   * Returns the available permissions for the given project and permissions
-   * list. See:
-   * https://cloud.google.com/resource-manager/reference/rest/v1/projects/testIamPermissions.
-   * For more information of Permission, see:
-   * https://cloud.google.com/iam/docs/overview#permissions.
-   * @param {!Array<string>} permissions Permissions array.
-   * @return {!Promise<!Array<string>>} The available permissions that current
-   *     operator (defined by ADC authentication information) has for the given
-   *     permission list.
-   */
-  async testIamPermissions(permissions) {
-    const resourceManager = google.cloudresourcemanager({
-      version: API_VERSION,
-      auth: await this.getAuth_(),
-    });
-    const projectId = await this.getProjectId_();
-    const request = {
-      resource_: projectId,
-      resource: {permissions: permissions},
-    };
-    return resourceManager.projects.testIamPermissions(request)
-        .then((response) => response.data.permissions);
-  }
-}
-
-module.exports = {
-  CloudPlatformApis,
-  API_VERSION,
-  API_SCOPES,
-};

package/src/apis/measurement_protocol.js

@@ -1,156 +0,0 @@
-// Copyright 2019 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 This is Google Analytics Measurement Protocol based on nodejs
- * 'request' library.
- */
-
-'use strict';
-
-const {request} = require('gaxios');
-const {
-  getLogger,
-  SendSingleBatch,
-  BatchResult,
-} = require('../components/utils.js');
-/** Base URL for Google Analytics service. */
-const BASE_URL = 'https://www.google-analytics.com';
-
-/**
- * Measurement Protocol hits are HTTP request. Reference:
- * 1. Measurement Protocol Parameter Reference
- * https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
- * 2. Google Analytics Collection Limits and Quotas
- * https://developers.google.com/analytics/devguides/collection/protocol/v1/limits-quotas
- * 3. Validating Hits - Measurement Protocol
- * https://developers.google.com/analytics/devguides/collection/protocol/v1/validating-hits
- * 4. Batching multiple hits in a single request
- * https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#batch
- */
-class MeasurementProtocol {
-  /**
-   * Measurement Protocol has a debug endpoint which will return the results of
-   * each hits. By given this initial parameter with 'true' value, this class
-   * can send hits to the debug endpoint.
-   * @param {boolean=} debugMode
-   */
-  constructor(debugMode = false) {
-    this.debugMode = debugMode;
-    this.logger = getLogger('API.MP');
-    this.logger.debug(`Init ${this.constructor.name} with Debug Mode.`);
-  }
-
-  /**
-   * Returns the function to send out a Measurement Protocol request with
-   * multiple hits.
-   * @param {!Object<string,string>} config Measurement Protocol common
-   *     configuration, e.g. web property ID.
-   * @return {!SendSingleBatch} Function which can send a batch of hits to
-   *     Measurement Protocol.
-   */
-  getSinglePingFn(config) {
-    /**
-     * Sends a batch of hits to Measurement Protocol.
-     * @param {!Array<string>} lines Data for single request. It should be
-     *     guaranteed that it doesn't exceed quota limitation.
-     * @param {string} batchId The tag for log.
-     * @return {!Promise<BatchResult>}
-     */
-    return async (lines, batchId) => {
-      const payload = lines.map((line) => {
-            const record = JSON.parse(line);
-            const hit = Object.assign({}, config, record);
-            return Object.keys(hit).map(
-                (key) => `${key}=${encodeURIComponent(hit[key])}`)
-                .join('&');
-          })
-          .join('\n');
-      // In debug mode, the path is fixed to '/debug/collect'.
-      const path = (this.debugMode) ? '/debug/collect' : '/batch';
-      const requestOptions = {
-        method: 'POST',
-        responseType: 'json',
-        url: `${BASE_URL}${path}`,
-        body: payload,
-        headers: {'User-Agent': 'Tentacles/MeasurementProtocol-v1'}
-      };
-      const response = await request(requestOptions);
-      /** @type {BatchResult} */ const batchResult = {
-        numberOfLines: lines.length,
-      };
-      if (response.status < 200 || response.status >= 300) {
-        const errorMessages = [
-          `Measurement Protocol [${batchId}] didn't succeed.`,
-          `Get response code: ${response.status}`,
-          `response: ${response.data}`,
-        ];
-        this.logger.error(errorMessages.join('\n'));
-        batchResult.errors = errorMessages;
-        batchResult.result = false;
-        return batchResult;
-      }
-      this.logger.debug(`Configuration:`, config);
-      this.logger.debug(`Input Data:   `, lines);
-      this.logger.debug(`Batch[${batchId}] status: ${response.status}`);
-      this.logger.debug(response.data);
-      // There is not enough information from the non-debug mode.
-      if (!this.debugMode) {
-        batchResult.result = true;
-      } else {
-        this.extraFailedLines_(batchResult, response.data.hitParsingResult,
-            lines);
-      }
-      return batchResult;
-    };
-  };
-
-  /**
-   * Extras failed lines based on the hitParsingResult, see:
-   * https://developers.google.com/analytics/devguides/collection/protocol/v1/validating-hits
-   *
-   * Note, only in 'debug' mode, Google Analytics will return this part of data.
-   *
-   * @param {!BatchResult} batchResult
-   * @param {!Array<!Object>} hitParsingResults
-   * @param {!Array<string>} lines The original input data.
-   * @private
-   */
-  extraFailedLines_(batchResult, hitParsingResults, lines) {
-    batchResult.failedLines = [];
-    batchResult.groupedFailed = {};
-    const errors = new Set();
-    hitParsingResults.forEach((result, index) => {
-      if (!result.valid) {
-        const failedLine = lines[index];
-        batchResult.failedLines.push(failedLine);
-        result.parserMessage.forEach(({description: error, messageType}) => {
-          this.logger.info(`[${messageType}]: ${error} for ${failedLine}`);
-          if (messageType === 'ERROR') {
-            errors.add(error);
-            const groupedFailed = batchResult.groupedFailed[error] || [];
-            groupedFailed.push(failedLine);
-            if (groupedFailed.length === 1) {
-              batchResult.groupedFailed[error] = groupedFailed;
-            }
-          }
-        });
-      }
-    });
-    batchResult.result = batchResult.failedLines.length === 0;
-    batchResult.errors = Array.from(errors);
-  }
-}
-
-module.exports = {MeasurementProtocol};