@google-cloud/nodejs-common 2.0.3-alpha → 2.0.4-alpha

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/nodejs-common",
-  "version": "2.0.3-alpha",
+  "version": "2.0.4-alpha",
   "description": "A NodeJs common library for solutions based on Cloud Functions",
   "author": "Google Inc.",
   "license": "Apache-2.0",

package/src/apis/dfa_reporting.js

@@ -41,12 +41,16 @@ const API_VERSION = 'v4';
  * profileId, idType, conversion, customVariables, encryptionInfo.
  * The 'idType' can be one of the values: 'encryptedUserId', 'gclid' or
  * 'mobileDeviceId'.
+ * The 'operation' can be 'insert' or 'update'. The default value is 'insert'.
+ * 'insert' stands for https://developers.google.com/doubleclick-advertisers/rest/v4/conversions/batchinsert
+ * 'update' stands for https://developers.google.com/doubleclick-advertisers/rest/v4/conversions/batchupdate
  * For other properties, see
  * https://developers.google.com/doubleclick-advertisers/guides/conversions_update
  *
  * @typedef {{
  *   profileId:string,
  *   idType:string,
+ *   operation:'insert'|'update'|undefined,
  *   conversion:{
  *     floodlightConfigurationId:string,
  *     floodlightActivityId:string,
@@ -60,7 +64,7 @@ const API_VERSION = 'v4';
  *   }|undefined),
  * }}
  */
-let InsertConversionsConfig;
+let ConversionsConfig;
 
 /**
  * List of properties that will be take from the data file as elements of a
@@ -155,7 +159,7 @@ class DfaReporting {
   /**
    * Returns the function to sends out a request to CM with a batch of
    * conversions.
-   * @param {!InsertConversionsConfig} config Campaign Manager configuration.
+   * @param {!ConversionsConfig} config Campaign Manager configuration.
    * @return {!SendSingleBatch} Function which can send a batch of hits to
    *     Campaign Manager.
    */
@@ -171,6 +175,15 @@ class DfaReporting {
       /** @type {function} Gets the conversion elements from the data object. */
       const filterObject = getFilterFunction(PICKED_PROPERTIES);
       const time = new Date().getTime();
+      const operation =
+        config.operation === 'update' ? 'batchupdate' : 'batchinsert';
+      // customVariables is not supported by batchupdate.
+      // https://developers.google.com/doubleclick-advertisers/rest/v4/Conversion#CustomFloodlightVariable
+      if (operation === 'batchupdate' &&
+        typeof config.customVariables !== 'undefined') {
+        this.logger.warn('customVariables is not supported by batchupdate');
+        delete config.customVariables;
+      }
       const conversions = lines.map((line) => {
         const record = JSON.parse(line);
         const conversion = Object.assign(
@@ -184,7 +197,7 @@ class DfaReporting {
         // Custom Variables
         if (typeof config.customVariables !== 'undefined') {
           conversion.customVariables = config.customVariables.map(
-              (variable) => ({'type': variable, 'value': record[variable],}));
+            (variable) => ({ 'type': variable, 'value': record[variable], }));
         }
         // User Identifiers
         if (record.userIdentifiers) {
@@ -225,7 +238,7 @@ class DfaReporting {
       };
       try {
         const dfareporting = await this.getApiClient_();
-        const response = await dfareporting.conversions.batchinsert({
+        const response = await dfareporting.conversions[operation]({
           profileId: config.profileId,
           requestBody: requestBody,
         });
@@ -411,7 +424,7 @@ class DfaReporting {
 
 module.exports = {
   DfaReporting,
-  InsertConversionsConfig,
+  ConversionsConfig,
   API_VERSION,
   API_SCOPES,
 };

package/src/apis/index.js

@@ -25,7 +25,7 @@ exports.AuthClient = require('./auth_client.js');
  * APIs integration class for DFA Reporting API.
  * @const {{
  *   DfaReporting:!DfaReporting,
- *   InsertConversionsConfig:!InsertConversionsConfig,
+ *   ConversionsConfig:!ConversionsConfig,
  * }}
  */
 exports.dfareporting = require('./dfa_reporting.js');

package/src/components/cloudfunctions_utils.js

@@ -229,4 +229,3 @@ module.exports = {
   getIdTokenForFunction,
   convertEnvPathToAbsolute,
 };
-

package/src/components/storage.js

@@ -255,4 +255,3 @@ module.exports = {
   LINE_BREAKER,
   DEFAULT_SPLIT_SIZE,
 };
-

package/src/components/utils.js

@@ -21,6 +21,8 @@
 const winston = require('winston');
 const {inspect} = require('util');
 const { LoggingWinston } = require('@google-cloud/logging-winston');
+const { request } = require('gaxios');
+const lodash = require('lodash');
 
 /**
  * The result of a batch of data sent to target API. The batch here means the
@@ -537,6 +539,34 @@ const changeNamingFromSnakeToLowerCamel = (name) => {
       (initial) => initial.substring(1).toUpperCase());
 };
 
+/**
+ * Returns the response data for a HTTP request. It will retry the specific
+ * times if there was errors happened.
+ * @param {object} options Options for the request.
+ * @param {object=} logger Default is `console`.
+ * @param {number=} retryTimes Default value 3.
+ * @return {object}
+ */
+const requestWithRetry = async (options, logger = console, retryTimes = 3) => {
+  let processedTimes = 0;
+  do {
+    // Wait sometime (2s, 4s, 8s, ...) before each retry.
+    if (processedTimes > 0) await wait(2 ** processedTimes * 1000);
+    try {
+      const requestOption = lodash.merge({
+        responseType: 'json',
+        method: 'POST',
+      }, options);
+      const response = await request(requestOption);
+      return response.data;
+    } catch (error) {
+      processedTimes++;
+      if (processedTimes > retryTimes) throw error;
+      logger.error(`Request ${JSON.stringify(options)}`, error);
+    }
+  } while (processedTimes <= retryTimes)
+}
+
 // noinspection JSUnusedAssignment
 module.exports = {
   getLogger,
@@ -554,4 +584,5 @@ module.exports = {
   getObjectByPath,
   changeNamingFromSnakeToUpperCamel,
   changeNamingFromSnakeToLowerCamel,
+  requestWithRetry,
 };