@google-cloud/nodejs-common 1.8.0 → 1.8.2-beta

package/src/components/cloudfunctions_utils.js

@@ -66,75 +66,14 @@ let MainFunctionOfStorage;
 let EventContext;
 
 /**
- * The first parameter passed to Cloud Functions as the 'Event' parameter in
- * Node6 environment.
- * @typedef {{
- *   data:(!StorageEventData|!PubsubMessage),
- *   context:!EventContext,
- * }}
- */
-let CloudFunctionEvent;
-
-/**
- * Storage event driven Cloud Functions in Node6 environment. It takes one
- * parameters and returns a Promise, see:
- * https://cloud.google.com/functions/docs/writing/background#functions_background_parameters-node6
- * @typedef {function(!CloudFunctionEvent):!Promise<*>}
- * @deprecated due to node6 env has benn sun set.
- */
-let CloudFunctionNode6;
-
-/**
- * Storage event driven Cloud Functions in Node8/10 environment. It takes two
+ * Storage event driven Cloud Functions in Node.js environment. It takes two
  * parameters, see:
  * https://cloud.google.com/functions/docs/writing/background#functions_background_parameters-node8-10
  * @typedef{function((!StorageEventData|!PubsubMessage),!EventContext):
  * !Promise<*>}
  */
-let CloudFunctionNode8;
-
-/**
- * Cloud Functions triggered by Cloud Storage events.
- *
- * @typedef {(!CloudFunctionNode6|!CloudFunctionNode8)}
- */
 let CloudFunction;
 
-/**
- * Gets a Node6 compatible Cloud Functions based on a Node8/10 Cloud Functions.
- * Cloud Functions have different parameter types and numbers in Node6 and
- * Node8/10:
- * 1. Node6 (deprecated) has (event, callback);
- * 2. Node8/10 has (data, context, callback).
- * see
- * https://cloud.google.com/functions/docs/writing/background#functions-writing-background-hello-pubsub-node8-10
- *
- * @param {!CloudFunctionNode8} fn Cloud Functions in Node8 environment.
- * @return {!CloudFunction} The Cloud Functions can return any type.
- */
-const adaptNode6 = (fn) => {
-  /**
-   * Returns the Cloud Function for both Node6 and Node8/10:
-   * @param {!CloudFunctionEvent|!PubsubMessage|!StorageEventData} eventOrData
-   *     The event payload for nodejs8/10 or The Cloud Functions event for
-   *     nodejs6.
-   * @param {?EventContext} possibleContext The event metadata for nodejs8/10
-   *     or undefined for nodejs6.
-   * @return {!Promise<*>}
-   */
-  return (eventOrData, possibleContext) => {
-    const /** @type {!StorageEventData|!PubsubMessage} */ data =
-        (!possibleContext)
-            ? (/** @type {CloudFunctionEvent} */ eventOrData).data
-            : eventOrData;
-    const /** @type {!EventContext} */ context =
-        (!possibleContext)
-            ? (/** @type {CloudFunctionEvent} */ eventOrData).context
-            : possibleContext;
-    return fn(data, context);
-  };
-};
-
 /**
  * Triggers the main function with the correct new coming file for once.
  * Detailed steps:
@@ -156,52 +95,45 @@ const adaptNode6 = (fn) => {
 const validatedStorageTrigger = (fn, folder, processed = 'processed/') => {
   /**
    * Returns the Cloud Function that can handle duplicated Storage triggers.
-   * @type {!CloudFunctionNode8}
+   * @type {!CloudFunction}
    */
-  const handleFile = (file, context) => {
-    const eventId = context.eventId;
+  const handleFile = async (file, context) => {
+    const { eventId } = context;
     const fileName = file.name;
     // The second condition prevents the event of folder creation.
     if (!fileName.startsWith(folder) || folder.startsWith(fileName)) {
-      const message = `Skip event[${eventId}]: ${fileName} not in the folder: ${
-          folder}.`;
+      const message =
+        `Skip event[${eventId}]: ${fileName} not in the folder: ${folder}.`;
       console.log(message);
-      return Promise.resolve(message);
-    } else {
+      return message;
+    }
+    try {
       const fileObj = new StorageFile(file.bucket, fileName);
-      return fileObj.getFile()
-          .move(join(processed, fileName))
-          .then(([newFile]) => {
-            console.log(
-                `Event[${eventId}] move: '${fileName}' to '${newFile.name}'`);
-            return fn({
-              name: newFile.name,
-              oldName: fileName,
-              bucket: file.bucket,
-              size: file.size,
-              updated: file.updated,
-            }).then(() => {
-              const message = `Event[${eventId}] completed: ${
-                  newFile.name} triggered the Cloud Functions.`;
-              console.log(message);
-              return message;
-            });
-          })
-          .catch((error) => {
-            let message;
-            if (error.message.startsWith('file#delete failed with an error')) {
-              message = `Quit event[${eventId}]: Fail to move ${
-                  fileName}. Maybe duplicated.`;
-            } else {
-              message = `Event[${eventId}] triggered: ${
-                  fileName} Cloud Functions got an error: ${error.message}`;
-            }
-            console.warn(message);
-            return message;
-          });
+      const [newFile] = await fileObj.getFile().move(join(processed, fileName));
+      console.log(`Event[${eventId}] move: '${fileName}' to '${newFile.name}'`);
+      await fn({
+        name: newFile.name,
+        oldName: fileName,
+        bucket: file.bucket,
+        size: file.size,
+        updated: file.updated,
+      });
+      const message =
+        `Event[${eventId}] completed: ${newFile.name} triggered the Cloud Functions.`;
+      console.log(message);
+      return message;
+    } catch (error) {
+      let message;
+      if (error.message.startsWith('file#delete failed with an error')) {
+        message = `Quit event[${eventId}]: Fail to move ${fileName}. Maybe duplicated.`;
+      } else {
+        message = `Event[${eventId}] triggered: ${fileName} Cloud Functions got an error: ${error.message}`;
+      }
+      console.warn(message);
+      return message;
     }
   };
-  return adaptNode6(handleFile);
+  return handleFile;
 };
 
 /**
@@ -245,10 +177,7 @@ module.exports = {
   ValidatedStorageFile,
   MainFunctionOfStorage,
   EventContext,
-  CloudFunctionEvent,
-  CloudFunctionNode8,
   CloudFunction,
-  adaptNode6,
   validatedStorageTrigger,
   convertEnvPathToAbsolute,
 };

package/src/components/firestore/access_base.js

@@ -153,7 +153,7 @@ class FirestoreAccessBase {
    * @param {string|number} id Document/Entity Id.
    * @return {!Promise<(!Entity|undefined)>}
    */
-  getObject(id) {
+  async getObject(id) {
   }
 
   /**
@@ -163,7 +163,7 @@ class FirestoreAccessBase {
    *     create a new one.
    * @return {!Promise<string|number>} The ID of saved document/entity.
    */
-  saveObject(data, id = undefined) {
+  async saveObject(data, id = undefined) {
   }
 
   /**
@@ -171,7 +171,7 @@ class FirestoreAccessBase {
    * @param {string|number} id Document/Entity Id.
    * @return {!Promise<boolean>} Whether the operation is succeeded.
    */
-  deleteObject(id) {
+  async deleteObject(id) {
   }
 
   /**
@@ -187,7 +187,7 @@ class FirestoreAccessBase {
    * @return {!Promise<!Array<{id:(string|number),entity:!Entity}>>} The
    *     documents or entities.
    */
-  queryObjects(filters, order, limit, offset) {
+  async queryObjects(filters, order, limit, offset) {
   }
 
   /**
@@ -197,7 +197,7 @@ class FirestoreAccessBase {
    *     invoked with a transaction. It returns any type.
    * @return {!Promise<*>} The return value of the function which is passed in.
    */
-  runTransaction(fn) {
+  async runTransaction(fn) {
   }
 
   /**
@@ -207,27 +207,30 @@ class FirestoreAccessBase {
    * related to a single entity in racing condition. For more complicated use
    * cases, use `runTransaction` to wrap the function directly.
    * @param {(string|number)} id Document/Entity Id.
-   * @param {!TransactionOperation} transactionOperation
+   * @param {!TransactionOperation} transactionOperation The operation will be
+   *   proceeded in a Transaction.
    * @return {function(!Transaction): Promise<boolean>}
    */
   wrapInTransaction(id, transactionOperation) {
   }
 
-  /**
-   * Returns whether the mode of Firestore is 'Native'.
-   * @return {!Promise<boolean>}
-   */
-  static async isNativeMode(projectId = process.env['GCP_PROJECT']) {
-    try {
-      await new Firestore({projectId}).listCollections();
-      return true;
-    } catch (error) {
-      console.log(`In detecting Firestore mode: `, error.message);
-      return false;
-    }
-  };
 }
 
+/**
+ * Returns whether the mode of Firestore is 'Native'.
+ * @param {string=} projectId GCP project Id.
+ * @return {!Promise<boolean>}
+ */
+async function isNativeMode(projectId = process.env['GCP_PROJECT']) {
+  try {
+    await new Firestore({ projectId }).listCollections();
+    return true;
+  } catch (error) {
+    console.log(`[No Panic] In detecting Firestore mode: `, error.message);
+    return false;
+  }
+};
+
 module.exports = {
   DataSource,
   Entity,
@@ -237,4 +240,5 @@ module.exports = {
   DatastoreDocumentFacade,
   DatastoreTransactionFacade,
   FirestoreAccessBase,
+  isNativeMode,
 };

package/src/components/firestore/data_access_object.js

@@ -41,14 +41,6 @@ const DatastoreModeAccess = require('./datastore_mode_access.js');
  */
 class DataAccessObject {
 
-  /**
-   * Returns the value of environment variable named 'FIRESTORE_TYPE'.
-   * @return {!DataSource}
-   */
-  static getDataSourceFromEnvironment() {
-    return process.env['FIRESTORE_TYPE'];
-  }
-
   /**
    * Initializes the instance based on given data source.
    * @param {string} kind The data model name.
@@ -56,8 +48,7 @@ class DataAccessObject {
    * @param {!DataSource} dataSource The data source type.
    * @param {string} projectId The Id of Cloud project.
    */
-  constructor(kind, namespace,
-      dataSource = DataAccessObject.getDataSourceFromEnvironment(),
+  constructor(kind, namespace, dataSource = process.env['FIRESTORE_TYPE'],
       projectId = process.env['GCP_PROJECT']) {
     /** @const {string} */ this.namespace = namespace;
     /** @const {!DataSource} */ this.dataSource = dataSource;
@@ -81,7 +72,7 @@ class DataAccessObject {
    * @param {!Entity} entity Data to save or update in the document/entity.
    * @return {!Promise<string|number>} The Id of saved document/entity.
    */
-  create(entity) {
+  async create(entity) {
     return this.accessObject.saveObject(entity);
   }
 
@@ -92,7 +83,7 @@ class DataAccessObject {
    * @param {string|number|undefined=} id Document/Entity Id.
    * @return {!Promise<string|number>} The ID of updated document/entity.
    */
-  update(entity, id) {
+  async update(entity, id) {
     return this.accessObject.saveObject(entity, id);
   }
 
@@ -103,10 +94,9 @@ class DataAccessObject {
    * @param {string|number|undefined=} id Document/Entity Id.
    * @return {!Promise<string|number>} The ID of updated document/entity.
    */
-  merge(options, id) {
-    return this.accessObject.getObject(id).then((entity) => {
-      return this.update(Object.assign(entity, options), id);
-    });
+  async merge(options, id) {
+    const entity = await this.accessObject.getObject(id);
+    return this.update(Object.assign(entity, options), id);
   }
 
   /**
@@ -114,7 +104,7 @@ class DataAccessObject {
    * @param {string|number} id Document/Entity Id.
    * @return {!Promise<(!Entity|undefined)>}
    */
-  load(id) {
+  async load(id) {
     return this.accessObject.getObject(id);
   }
 
@@ -123,7 +113,7 @@ class DataAccessObject {
    * @param {string|number} id Document/Entity Id.
    * @return {!Promise<boolean>} Whether the operation is succeeded.
    */
-  remove(id) {
+  async remove(id) {
     return this.accessObject.deleteObject(id);
   }
 
@@ -137,10 +127,10 @@ class DataAccessObject {
    * https://googleapis.dev/nodejs/datastore/latest/Query.html#order
    * @param {number|undefined} limit A limit on a query.
    * @param {number|undefined} offset An offset on a query.
-   * @return {!Array<{id:(string|number),entity:!Entity}>} The documents or
-   *     entities.
+   * @return {!Promise<Array<{id:(string|number),entity:!Entity}>>} The array of
+   *     documents or entities.
    */
-  list(filters, order, limit, offset) {
+  async list(filters, order, limit, offset) {
     return this.accessObject.queryObjects(filters, order, limit, offset);
   }
 
@@ -151,7 +141,7 @@ class DataAccessObject {
    *     invoked with a transaction. It returns any type.
    * @return {!Promise<*>} The return value of the function which is passed in.
    */
-  runTransaction(fn) {
+  async runTransaction(fn) {
     return this.accessObject.runTransaction(fn);
   }
 

package/src/components/firestore/datastore_mode_access.js

@@ -78,20 +78,19 @@ class DatastoreModeAccess {
   }
 
   /** @override */
-  getObject(id) {
+  async getObject(id) {
     const key = this.getKey(id);
-    return this.datastore.get(key)
-        .then(([entity, error]) => {
-          if (!error) {
-            this.logger.debug(`Get ${id}@${this.kind}`, entity);
-            return entity;
-          } else {
-            console.log(`Not found ${id}@${this.kind}`, error);
-          }
-        })
-        .catch((error) => {
-          console.error(error);
-        });
+    try {
+      const [entity] = await this.datastore.get(key);
+      if (entity) {
+        this.logger.debug(`Get ${id}@${this.kind}`, entity);
+        return entity;
+      } else {
+        this.logger.info(`Not found ${id}@${this.kind}`);
+      }
+    } catch (error) {
+      this.logger.error(error);
+    };
   }
 
   /**
@@ -99,52 +98,46 @@ class DatastoreModeAccess {
    * @param {string|number} id
    * @return {!Promise<string|number>}
    */
-  waitUntilGetObject(id) {
-    return this.getObject(id).then((entity) => {
-      if (entity) return id;
-      this.logger.debug(`Wait 1 more second until the eneity@${id} is ready`);
-      return wait(1000, this.waitUntilGetObject(id));
-    });
+  async waitUntilGetObject(id) {
+    const entity = await this.getObject(id);
+    if (entity) return id;
+    this.logger.debug(`Wait 1 more second until the eneity@${id} is ready`);
+    return wait(1000, this.waitUntilGetObject(id));
   }
 
   /** @override */
-  saveObject(data, id = undefined) {
+  async saveObject(data, id = undefined) {
     this.logger.debug(`Start to save entity ${id}@${this.kind}`, data);
     const key = this.getKey(id);
-    return this.datastore
-        .save({
-          key: key,
-          data: data,
-          excludeLargeProperties: true,
-        })
-        .then((apiResponse) => {
-          // Default key in Datastore is a number in response like following.
-          // With a given id, the key in response is null.
-          const updatedId = id !== undefined ? id
-              : +apiResponse[0]['mutationResults'][0].key.path[0].id;
-          this.logger.debug(
-              `Result of saving ${updatedId}@${this.kind}: `,
-              JSON.stringify(apiResponse));
-          // Datastore has a delay to write entity. This method only returns id
-          // after it is created. For updating, it always return at once because
-          // the entity exists.
-          return this.waitUntilGetObject(updatedId);
-        });
+    const apiResponse =
+      await this.datastore.save({ key, data, excludeLargeProperties: true });
+    // Default key in Datastore is a number in response like following.
+    // With a given id, the key in response is null.
+    const updatedId = id !== undefined ? id
+      : +apiResponse[0].mutationResults[0].key.path[0].id;
+    this.logger.debug(`Result of saving ${updatedId}@${this.kind}: `,
+      JSON.stringify(apiResponse));
+    // Datastore has a delay to write entity. This method only returns id
+    // after it is created. For updating, it always return at once because
+    // the entity exists.
+    return this.waitUntilGetObject(updatedId);
   }
 
   /** @override */
-  deleteObject(id) {
+  async deleteObject(id) {
     const key = this.getKey(id);
-    return this.datastore.delete(key).then((apiResponse, error) => {
+    try {
+      const apiResponse = await this.datastore.delete(key);
       this.logger.debug(`Delete ${id}@${this.kind}: `,
-          JSON.stringify(apiResponse));
+        JSON.stringify(apiResponse));
       // Returns true even try to delete a deleted entity. The responses of
       // delete operations only differ at the property 'indexUpdates' for a
       // normal entity and a deleted entity.
-      if (!error) return true;
-      console.error(`Error in deleting ${id}@${this.kind}`, error);
+      return true;
+    } catch (error) {
+      this.logger.error(`Error in deleting ${id}@${this.kind}`, error);
       return false;
-    });
+    }
   }
 
   /** @override */
@@ -164,7 +157,7 @@ class DatastoreModeAccess {
       this.datastore.runQueryStream(query)
           .on('error',
               (error) => {
-                console.error(error);
+                this.logger.error(error);
                 reject(error);
               })
           .on('data',
@@ -174,7 +167,7 @@ class DatastoreModeAccess {
               })
           .on('info',
               (info) => {
-                console.log(`Info event: ${JSON.stringify(info)}`);
+                this.logger.info(`Info event: ${JSON.stringify(info)}`);
               })
           .on('end', () => {
             resolve(result);
@@ -190,35 +183,36 @@ class DatastoreModeAccess {
    *
    * @override
    */
-  runTransaction(fn) {
+  async runTransaction(fn) {
     let leftRetries = MAX_RETRY_TIMES;
-    const runFn = () => this.datastore.transaction().run().then(
-        ([transaction]) => fn(transaction));
-    const retryFn = (error) => {
-      console.log(
+    const runFn = async () => {
+      const [transaction] = await this.datastore.transaction().run();
+      return fn(transaction);
+    };
+    const retryFn = async (error) => {
+      this.logger.info(
           `TX ERROR[${error.message}]. Retries left: ${leftRetries} times.`);
       leftRetries--;
-      return wait(500 * (MAX_RETRY_TIMES - leftRetries)).then(() => {
-        if (leftRetries === 0) return runFn();
-        return runFn().catch(retryFn);
-      });
+      await wait(500 * (MAX_RETRY_TIMES - leftRetries));
+      if (leftRetries === 0) return runFn();
+      return runFn().catch(retryFn);
     };
     return runFn().catch(retryFn);
   }
 
   /** @override */
   wrapInTransaction(id, transactionOperation) {
-    return (transaction) => {
-      console.log(`Transaction starts for ${this.kind}@${id}.`);
+    return async (transaction) => {
+      this.logger.info(`Transaction starts for ${this.kind}@${id}.`);
       const key = this.getKey(id);
-      return transaction.get(key).then(([entity]) => {
-        const result = transactionOperation(
-            new DatastoreDocumentFacade(entity),
-            key,
-            new DatastoreTransactionFacade(transaction, entity)
-        );
-        return transaction.commit().then(() => result);
-      });
+      const [entity] = await transaction.get(key);
+      const result = transactionOperation(
+        new DatastoreDocumentFacade(entity),
+        key,
+        new DatastoreTransactionFacade(transaction, entity)
+      );
+      await transaction.commit();
+      return result;
     };
   }
 }