├── .firebaserc ├── .gitignore ├── LICENSE ├── appengine ├── app.yaml ├── cron.yaml ├── main.py ├── main_test.py ├── pubsub_utils.py └── requirements.txt ├── firebase.json ├── functions ├── index.js └── package.json └── readme.md /.firebaserc: -------------------------------------------------------------------------------- 1 | {} 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | appengine/lib/** 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /appengine/app.yaml: -------------------------------------------------------------------------------- 1 | runtime: python27 2 | api_version: 1 3 | threadsafe: true 4 | 5 | handlers: 6 | 7 | # Handler for the pubsub cron. 8 | - url: /publish/.* 9 | script: main.app 10 | login: admin 11 | secure: always 12 | 13 | - url: /.* 14 | script: main.app 15 | 16 | libraries: 17 | - name: webapp2 18 | version: latest 19 | - name: pycrypto 20 | version: latest 21 | - name: ssl 22 | version: latest 23 | 24 | instance_class: F1 25 | -------------------------------------------------------------------------------- /appengine/cron.yaml: -------------------------------------------------------------------------------- 1 | cron: 2 | - description: Push a "tick" onto pubsub every hour 3 | url: /publish/hourly-tick 4 | schedule: every 1 hours 5 | 6 | - description: Push a "tick" onto pubsub every day 7 | url: /publish/daily-tick 8 | schedule: every 24 hours 9 | 10 | - description: Push a "tick" onto pubsub every week 11 | url: /publish/weekly-tick 12 | schedule: every saturday 00:00 13 | -------------------------------------------------------------------------------- /appengine/main.py: -------------------------------------------------------------------------------- 1 | # Copyright 2017 Google Inc. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | import webapp2 16 | import time 17 | import json 18 | import pubsub_utils 19 | 20 | class PushToPubSub(webapp2.RequestHandler): 21 | def get(self, topic): 22 | pubsub_utils.publish_to_topic(topic, str(time.time())) 23 | 24 | self.response.headers['Content-Type'] = 'application/json' 25 | self.response.write(json.dumps({"status": "200"})) 26 | 27 | app = webapp2.WSGIApplication([ 28 | webapp2.Route(r'/publish/', handler=PushToPubSub) 29 | ], debug=True) 30 | -------------------------------------------------------------------------------- /appengine/main_test.py: -------------------------------------------------------------------------------- 1 | # Copyright 2017 Google Inc. All rights reserved. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | import webtest 16 | 17 | import main 18 | 19 | 20 | def test_get(): 21 | app = webtest.TestApp(main.app) 22 | 23 | response = app.get('/') 24 | 25 | assert response.status_int == 200 26 | assert response.body == 'Hello, World!' 27 | -------------------------------------------------------------------------------- /appengine/pubsub_utils.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | # Copyright 2017 Google Inc. All Rights Reserved. 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | """Pub/Sub Utility module for this sample.""" 17 | 18 | import sys 19 | sys.path.append("./lib") 20 | 21 | import base64 22 | from time import strftime 23 | import httplib2 24 | import oauth2client.contrib.appengine as gae_oauth2client 25 | from apiclient import discovery 26 | from google.appengine.api import memcache 27 | from google.appengine.api import app_identity 28 | from google.appengine.api import urlfetch 29 | 30 | from googleapiclient.errors import HttpError 31 | 32 | PUBSUB_SCOPES = ["https://www.googleapis.com/auth/pubsub"] 33 | 34 | def get_client(): 35 | """Creates Pub/Sub client and returns it.""" 36 | credentials = gae_oauth2client.AppAssertionCredentials(scope=PUBSUB_SCOPES) 37 | http = httplib2.Http(memcache) 38 | credentials.authorize(http) 39 | 40 | return discovery.build('pubsub', 'v1', http=http) 41 | 42 | 43 | def get_full_topic_name(name): 44 | return 'projects/{}/topics/{}'.format(get_project_id(), name) 45 | 46 | 47 | def get_project_id(): 48 | return app_identity.get_application_id() 49 | 50 | 51 | def publish_to_topic(topic, msg='', create=True): 52 | urlfetch.set_default_fetch_deadline(180) 53 | pubsub = get_client() 54 | full_name = get_full_topic_name(topic) 55 | message = {"messages": [{"data": base64.b64encode(msg)}]} 56 | try: 57 | pubsub.projects().topics().publish(topic=full_name, 58 | body=message).execute() 59 | except HttpError as e: 60 | if create and e.resp.status == 404 and "Resource not found" in e.content: 61 | pubsub.projects().topics().create(name=full_name, 62 | body={}).execute() 63 | pubsub.projects().topics().publish(topic=full_name, 64 | body=message).execute() 65 | else: 66 | raise 67 | -------------------------------------------------------------------------------- /appengine/requirements.txt: -------------------------------------------------------------------------------- 1 | google-api-python-client 2 | -------------------------------------------------------------------------------- /firebase.json: -------------------------------------------------------------------------------- 1 | {} 2 | -------------------------------------------------------------------------------- /functions/index.js: -------------------------------------------------------------------------------- 1 | // Copyright 2017 Google Inc. All rights reserved. 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | var functions = require('firebase-functions'); 16 | 17 | exports.hourly_job = 18 | functions.pubsub.topic('hourly-tick').onPublish((event) => { 19 | console.log("This job is ran every hour!") 20 | }); 21 | -------------------------------------------------------------------------------- /functions/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "functions", 3 | "description": "Cloud Functions for Firebase", 4 | "dependencies": { 5 | "firebase-admin": "^4.1.2", 6 | "firebase-functions": "^0.5" 7 | }, 8 | "private": true 9 | } 10 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # App Engine Cron with Google Cloud Functions for Firebase 2 | Google App Engine provides a Cron service. Using this service for scheduling and 3 | Google Cloud Pub/Sub for distributed messaging, you can build an application to 4 | reliably schedule tasks which can trigger Google Cloud Functions. 5 | 6 | This sample contains two components: 7 | 8 | * An App Engine application, that uses App Engine Cron Service 9 | to relay cron messages to Cloud Pub/Sub topics. 10 | 11 | * A sample Cloud Function which triggers hourly. 12 | 13 | ## Configuration 14 | 15 | By default this sample triggers hourly, daily, and weekly. If you want to 16 | customize this schedule for your app then you can modify the [cron.yaml](/appengine/cron.yaml). 17 | 18 | For details on configuring this, please see the [cron.yaml Reference](https://cloud.google.com/appengine/docs/standard/python/config/cronref) 19 | in the App Engine documentation. 20 | 21 | ## Deploying 22 | The overview for configuring and running this sample is as follows: 23 | 24 | ### 1. Prerequisites 25 | 26 | * If you don’t already have one, create a 27 | [Google Account](https://accounts.google.com/SignUp). 28 | 29 | * Create a Developers Console project. 30 | 1. Install (or check that you have previously installed) 31 | * [`git`](https://git-scm.com/downloads) 32 | * [Python 2.7](https://www.python.org/download/releases/2.7/) 33 | * [Python `pip`](https://pip.pypa.io/en/latest/installing.html) 34 | * [Google Cloud SDK](http://cloud.google.com/sdk/) 35 | 2. [Enable the Pub/Sub API](https://console.cloud.google.com/flows/enableapi?apiid=pubsub&redirect=https://console.cloud.google.com) 36 | 3. [Enable Project Billing](https://support.google.com/cloud/answer/6293499#enable-billing) 37 | 38 | 39 | ### 2. Clone this repository 40 | 41 | To clone the GitHub repository to your computer, run the following command: 42 | 43 | $ git clone https://github.com/firebase/functions-cron 44 | 45 | Change directories to the `functions-cron` directory. The exact path 46 | depends on where you placed the directory when you cloned the sample files from 47 | GitHub. 48 | 49 | $ cd functions-cron 50 | 51 | Leave the default cron.yaml as is for now to run through the sample. 52 | 53 | ### 3. Deploy to App Engine 54 | 55 | 1. Configure the `gcloud` command-line tool to use the project your Firebase project. 56 | ``` 57 | $ gcloud config set project 58 | ``` 59 | 2. Change directory to `appengine/` 60 | ``` 61 | $ cd appengine/ 62 | ``` 63 | 3. Install the Python dependencies 64 | ``` 65 | $ pip install -t lib -r requirements.txt 66 | ``` 67 | 4. Create an App Engine App 68 | ``` 69 | $ gcloud app create 70 | ``` 71 | 5. Deploy the application to App Engine. 72 | ``` 73 | $ gcloud app deploy app.yaml \cron.yaml 74 | ``` 75 | 6. Open [Google Cloud Logging](https://console.cloud.google.com/logs/viewer) and in the right dropdown select "GAE Application". If you don't see this option, it may mean that App Engine is still in the process of deploying. 76 | 7. Look for a log entry calling `/_ah/start`. If this entry isn't an error, then you're done deploying the App Engine app. 77 | 78 | ### 3. Deploy to Google Cloud Functions for Firebase 79 | 80 | 1. Ensure you're back the root of the repository (`cd ..`, if you're coming from Step 2) 81 | 1. Deploy the sample `hourly_job` function to Google Cloud Functions 82 | ``` 83 | $ firebase deploy --only functions --project 84 | ``` 85 | **Warning:** This will remove any existing functions you have deployed. 86 | If you have existing functions, move the example from [functions/index.js](functions/index.js) 87 | into your project's `index.js` 88 | 89 | ### 4. Verify your Cron Jobs 90 | We can verify that our function is wired up correctly by opening the [Task Queue](https://console.cloud.google.com/appengine/taskqueues) tab in AppEngine and 91 | clicking on **Cron Jobs**. Each of these jobs has a **Run Now** button next to it. 92 | 93 | The sample functions we deployed only has one function: `hourly_job`. To trigger 94 | this job, let's hit the **Run Now** button for the `/publish/hourly-tick` job. 95 | 96 | Then, go to your terminal and run... 97 | 98 | ``` 99 | $ firebase functions:log --project 100 | ``` 101 | 102 | You should see a successful `console.log` from your `hourly_job`. 103 | 104 | ### 5. You're Done! 105 | 106 | Your cron jobs will now "tick" along forever. As I mentioned above, you're not 107 | limited to the `hourly-tick`, `daily-tick` and `weekly-tick` that are included 108 | in the AppEngine app. You can add more scheduled functions by modifying the [cron.yaml](/appengine/cron.yaml) file and re-deploying. 109 | 110 | ## License 111 | 112 | Copyright 2017 Google Inc. All Rights Reserved. 113 | 114 | Licensed under the Apache License, Version 2.0 (the "License"); 115 | you may not use this file except in compliance with the License. 116 | You may obtain a copy of the License at 117 | 118 | http://www.apache.org/licenses/LICENSE-2.0 119 | 120 | Unless required by applicable law or agreed to in writing, software 121 | distributed under the License is distributed on an "AS IS" BASIS, 122 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 123 | See the License for the specific language governing permissions and 124 | limitations under the License. 125 | --------------------------------------------------------------------------------