upgrade cloud functions

.gitignore

@@ -1 +1,2 @@
-_*
+_*
+.venv

docs/conf.py

@@ -30,7 +30,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ["sphinx_rtd_theme"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -68,12 +68,12 @@
     'github_version': 'master/',
 }
 
-if not on_rtd:
-    import sphinx_rtd_theme
-    html_theme = 'sphinx_rtd_theme'
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+# if not on_rtd:
+#     import sphinx_rtd_theme
+#     html_theme = 'sphinx_rtd_theme'
+#     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
-# html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/index.rst

@@ -4,7 +4,7 @@ Complete Guide to Firebase WordPress Integration
 .. meta::
    :description lang=en: Guide on how to integrate Firebase to WordPress.
 
-Last updated: Feb 25, 2024
+Last updated: Mar 14, 2024
 
 .. raw:: html
 
@@ -50,7 +50,7 @@ Products
 -----------
 
 - `Integrate Firebase PRO <https://techcater.com/>`_ - `v3.34.0`
-- `Firebase WordPress Functions <https://firebase-wordpress-docs.readthedocs.io/en/latest/intro/cloud-functions-deployment.html>`_ - `v1.8.0` (bundle with PRO plugin)
+- `Firebase WordPress Functions <https://firebase-wordpress-docs.readthedocs.io/en/latest/intro/cloud-functions-deployment.html>`_ - `v2.0.0` (bundle with PRO plugin)
 - `Integrate Firebase Woocommerce <https://firebase-wordpress-docs.readthedocs.io/en/latest/extensions/woocommerce.html>`_ - `v2.16.0` (Extension)
 - `Integrate Firebase Users <https://firebase-wordpress-docs.readthedocs.io/en/latest/extensions/firebase-users.html>`_ - `v1.3.2` (Extension)
 - `Firebase JWT <https://firebase-wordpress-docs.readthedocs.io/en/latest/extensions/jwt.html>`_ - `v1.2.1` (Extension)
@@ -64,6 +64,7 @@ This guide is mostly for the PRO version, if you are using the FREE version, ple
 * :doc:`/intro/introduction`
 * :doc:`/intro/ifp-plugin-configuration`
 * :doc:`/intro/cloud-functions-deployment`
+* :doc:`/intro/cloud-functions-deployment-v2`
 * :doc:`/intro/shortcode-list`
 * :doc:`/intro/update-plugin`
 
@@ -75,6 +76,7 @@ This guide is mostly for the PRO version, if you are using the FREE version, ple
    /intro/introduction
    /intro/ifp-plugin-configuration
    /intro/cloud-functions-deployment
+   /intro/cloud-functions-deployment-v2
    /intro/shortcode-list
    /intro/update-plugin
 

docs/intro/cloud-functions-deployment-v2.rst

@@ -0,0 +1,142 @@
+.. raw:: html
+
+    <style> .red {color:red} </style>
+
+Firebase Cloud Functions Deployment (v2)
+=============
+
+.. role:: red
+
+:red:`Since v2.0.0, if you already installed the cloud functions before v2, you have to delete those functions before deploying the new one.`
+
+If you are using PRO version, there is another folder named **firebase-wordpress-functions**. If you want to manage database, Firebase users and custom functions, you should deploy the functions together with the plugin. Make sure that you have Nodejs installed on your machine. 
+
+The cloud functions is only Admin Dashboard tasks, you don't have to deploy the cloud functions for frontend interactions such as login, display or retrieve data.
+
+If you want a hands-on guide, you can watch this tutorial: `How to Deploy Cloud Functions <https://www.youtube.com/watch?v=D-xvzJ9K8jw>`_
+
+.. raw:: html
+
+    <div style="position: relative; padding-bottom: 10%; height: 0; overflow: hidden; max-width: 100%; height: auto;">
+    <iframe width="560" height="315" src="https://www.youtube.com/embed/D-xvzJ9K8jw" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+    </div>
+
+Prerequisite
+`````````````
+
+In order to deploy cloud functions, you need to have `Nodejs v12 <https://nodejs.org/dist/latest-v12.x/>`_ installed on your machine. 
+
+On Google Cloud Platform, go to your project and make sure Cloud Build API and Cloud Functions are enabled. And the account that you use to deploy has `Service Account User` and `Cloud Functions Admin` Role in order to deploy cloud functions to Firebase.
+
+Then install `firebase-tools <https://firebase.google.com/docs/cli>`_ packaged
+
+.. code-block:: bash
+
+    npm install -g firebase-tools
+
+SignIn and test firebase cli
+
+.. code-block:: bash
+
+    firebase login
+
+Since version 0.6.0, before deploying any functions, you should create two tokens for security purpose. One for Wordpress dashboard usage, the other is for WordPress frontend.
+
+.. code-block:: bash
+
+    // Generate two random tokens - save in notepad, you will need them later
+
+    // DASHBOARD_TOKEN
+    node -e "console.log(require('crypto').randomBytes(20).toString('hex'))"
+
+    // FRONTEND_TOKEN
+    node -e "console.log(require('crypto').randomBytes(20).toString('hex'))"
+
+Change Your Plan to Blaze
+`````````````
+
+**Why will I need a billing account to use the Node.js 10 runtime for Cloud Functions for Firebase?**
+
+Because of updates to its underlying architecture planned for August 17, 2020, Cloud Functions for Firebase will rely on some additional paid Google services: Cloud Build, Container Registry, and Cloud Storage. These architecture updates will apply for functions deployed to the Node.js 10 runtime. `Usage of these services will be billed in addition to existing pricing <https://firebase.google.com/support/faq#pricing-blaze-free>`_.
+
+.. figure:: /images/intro/pay-as-you-go.png
+    :scale: 70%
+    :align: center
+
+    Firebase pricing plans
+
+Change Cloud Functions Regions
+`````````````
+
+You can type the name of the region that you want to deploy the cloud functions at deploy time. 
+
+.. code-block:: bash
+
+    ? Enter a string value for FRONTEND_TOKEN: YOUR_SECRET_TOKEN
+    ? Enter a string value for DASHBOARD_TOKEN: YOUR_SECRET_TOKEN
+    ? Enter a string value for REGIONS: us-central1
+    ? Enter an integer value for USER_API_MININSTANCES: 0
+
+After configuration, those information will be saved to an environment file in your folder:
+
+.. code-block:: bash
+
+    i  functions: Created new local file .env.YOUR_PROJECT_ID to store param values. We suggest explicitly adding or excluding this file from version control.
+
+
+If you want to change the region of the cloud function, you can update the file and redeploy the cloud functions.
+
+Install Packages & Deploy Cloud Functions
+`````````````
+
+Install packages and build functions. I'm using Yarn, you can use npm if you want.
+
+.. code-block:: bash
+
+    cd functions/
+    yarn OR npm install
+
+The code will go to *functions* folder, then installs packages with yarn / npm.
+
+Start deploying firebase functions
+
+.. code-block:: bash
+
+    cd functions
+    firebase deploy --only functions --project project-id
+
+The deployment result should look like this
+
+.. code-block:: bash 
+
+    ✔  functions: Finished running predeploy script.
+    i  functions: ensuring necessary APIs are enabled...
+    ✔  functions: all necessary APIs are enabled
+    i  functions: preparing functions directory for uploading...
+    i  functions: packaged functions (103.29 KB) for uploading
+    ✔  functions: functions folder uploaded successfully
+    i  functions: updating Node.js 10 (Beta) function api-user(us-central1)...
+    i  functions: updating Node.js 10 (Beta) function api-database(us-central1)...
+    ✔  functions[api-user(us-central1)]: Successful update operation. 
+    ✔  functions[api-database(us-central1)]: Successful update operation. 
+
+    ✔  Deploy complete!
+
+    Project Console: https://console.firebase.google.com/project/project-id/overview
+    ✨  Done in 77.56s.
+
+After that, you should update your Firebase setting with the dashboard token and frontend token and firebase functions url (e.g. *https://us-central1-project-id.cloudfunctions.net*)
+
+.. figure:: /images/firebase-setting.png
+    :scale: 70%
+    :align: center
+
+    Firebase setting
+
+Just to verify that everything works, you can find three cloud functions in your firebase console after the deployment. 
+
+.. figure:: /images/firebase-cloud-functions.png
+    :scale: 70%
+    :align: center
+
+    Firebase cloud functions

docs/intro/cloud-functions-deployment.rst

@@ -18,7 +18,7 @@ Prerequisite
 
 In order to deploy cloud functions, you need to have `Nodejs v12 <https://nodejs.org/dist/latest-v12.x/>`_ installed on your machine. 
 
-On Google Cloud Platform, go to your project and make sure Cloud Buid API and Cloud Functions are enabled. And the account that you use to deploy has `Service Account User` and `Cloud Functions Admin` Role in order to deploy cloud functions to Firebase.
+On Google Cloud Platform, go to your project and make sure Cloud Build API and Cloud Functions are enabled. And the account that you use to deploy has `Service Account User` and `Cloud Functions Admin` Role in order to deploy cloud functions to Firebase.
 
 Then install `firebase-tools <https://firebase.google.com/docs/cli>`_ packaged
 
@@ -127,7 +127,7 @@ The deployment result should look like this
     Project Console: https://console.firebase.google.com/project/project-id/overview
     ✨  Done in 77.56s.
 
-After that, you should update your Firebase setting with the dashboad token and frontend token and firebase functions url (e.g. *https://us-central1-project-id.cloudfunctions.net*)
+After that, you should update your Firebase setting with the dashboard token and frontend token and firebase functions url (e.g. *https://us-central1-project-id.cloudfunctions.net*)
 
 .. figure:: /images/firebase-setting.png
     :scale: 70%

docs/requirements.txt

@@ -1,2 +1,2 @@
 docutils==0.17.1
-sphinx_rtd_theme==1.1.1
+sphinx_rtd_theme==2.0.0