[ { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "content": "---\nname: Bug report\nabout: Report an issue with a specific sample\ntitle: '[BUG] in sample: '\nlabels: 'type: bug'\nassignees: ''\n---\n\n### Which sample has a bug?\n\n**Sample name or URL where you found the bug**\n\n### How to reproduce the issue\n\n**Failing Function code used (if you modified the sample)**\n\n**Steps to set up and reproduce**\n\n\n\n### Debug output\n\n\n\n**Errors in the\n[console logs](https://console.firebase.google.com/project/_/functions/logs?search=&severity=DEBUG)**\n\n**Screenshots**\n\n### Expected behavior\n\n\n\n### Actual behavior\n\n\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "# Copyright 2023 Google LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# https://docs.github.com/en/free-pro-team@latest/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser\n\nblank_issues_enabled: false\ncontact_links:\n - name: Propose a new sample, or get help setting up a sample\n url: https://github.com/firebase/functions-samples/discussions\n about: Informal help and discussion about the samples in this repository.\n - name: Issues with the Firebase platform\n url: https://firebase.google.com/support\n about: Report issues with Firebase services to Firebase support.\n" }, { "path": ".github/ISSUE_TEMPLATE/docs.md", "content": "---\nname: Documentation issue\nabout: Are a sample's docs incorrect or unclear?\ntitle: '[DOCS] for sample: '\nlabels: ''\nassignees: ''\n---\n\n\n\n### Which sample?\n\n**Sample name or URL** **Link to closest heading**\n\n### What is the issue with this sample's docs?\n\n\n" }, { "path": ".github/workflows/test_node.yml", "content": "# Copyright 2023 Google LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nname: 2nd Gen CI Tests\n\non:\n pull_request:\n paths:\n - 'Node/**'\n - 'package.json'\n - 'package-lock.json'\n - 'pnpm-workspace.yaml'\n - 'pnpm-lock.yaml'\n - 'tsconfig.template.json'\n push:\n branches:\n - main\n paths:\n - 'Node/**'\n - 'package.json'\n - 'package-lock.json'\n - 'pnpm-workspace.yaml'\n - 'pnpm-lock.yaml'\n - 'tsconfig.template.json'\n\nenv:\n CI: true\n\njobs:\n unit:\n runs-on: ubuntu-latest\n strategy:\n matrix:\n node-version:\n # The latest Node version for 2nd gen\n # https://cloud.google.com/functions/docs/runtime-support#node.js\n - 22.x\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n with:\n node-version: ${{ matrix.node-version }}\n\n - name: Cache npm\n uses: actions/cache@v4\n with:\n path: ~/.npm\n key: ${{ runner.os }}-node-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}\n\n - run: npm install\n - run: npm run bootstrap-2nd-gen\n - run: npm run lint-2nd-gen\n - run: npm run compile-2nd-gen\n - run: npm run test-2nd-gen\n" }, { "path": ".github/workflows/test_node_1st_gen.yml", "content": "# Copyright 2023 Google LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nname: 1st Gen CI Tests\n\non:\n pull_request:\n paths:\n - 'Node-1st-gen/**'\n - 'package.json'\n - 'package-lock.json'\n - 'pnpm-workspace.yaml'\n - 'pnpm-lock.yaml'\n - 'tsconfig.template.json'\n push:\n branches:\n - main\n paths:\n - 'Node-1st-gen/**'\n - 'package.json'\n - 'package-lock.json'\n - 'pnpm-workspace.yaml'\n - 'pnpm-lock.yaml'\n - 'tsconfig.template.json'\n\nenv:\n CI: true\n\njobs:\n unit:\n runs-on: ubuntu-latest\n strategy:\n matrix:\n node-version:\n # The latest Node version for 1st gen\n # https://cloud.google.com/functions/docs/runtime-support#node.js\n - 20.x\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n with:\n node-version: ${{ matrix.node-version }}\n\n - name: Cache npm\n uses: actions/cache@v4\n with:\n path: ~/.npm\n key: ${{ runner.os }}-node-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}\n\n - run: npm install\n - run: npm run bootstrap-1st-gen\n - run: npm run lint-1st-gen\n - run: npm run compile-1st-gen\n - run: npm run test-1st-gen\n" }, { "path": ".github/workflows/test_python.yml", "content": "# Copyright 2023 Google LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nname: CI Tests\n\non:\n pull_request:\n paths:\n - 'Python/**'\n\n push:\n branches:\n - main\n paths:\n - 'Python/**'\n\nenv:\n CI: true\n\njobs:\n unit:\n runs-on: ubuntu-latest\n strategy:\n matrix:\n python-version:\n - \"3.10\"\n - \"3.11\"\n steps:\n - uses: actions/checkout@v3\n - name: Set up Python ${{ matrix.python-version }}\n uses: actions/setup-python@v4\n with:\n python-version: ${{ matrix.python-version }}\n - name: Install dependencies\n working-directory: ./Python\n run: pip install -r requirements.txt\n - name: Lint\n working-directory: ./Python\n run: python pyfmt.py --check_only --exclude \"**/venv/**/*.py\" **/*.py\n" }, { "path": ".gitignore", "content": ".idea\n**/node_modules/*\n**/.firebase\n**/.firebaserc\n**/.runtimeconfig.json\n*/npm-debug.log\nlerna-debug.log\n*~\nservice-account-credentials.json\n**/package-lock.json\n# keep the root package-lock so that tools are consistent\n!/package-lock.json\n**/ui-debug.log\n**/database-debug.log\n**/firebase-debug.log\n**/pubsub-debug.log\n**/tsconfig-compile.json\nyarn.lock\n**/.DS_Store\n" }, { "path": ".opensource/project.json", "content": "{\n \"name\": \"Cloud Functions Samples\",\n \"type\": \"sample\",\n \"platforms\": [\n \"Admin\",\n \"Node\"\n ],\n \"content\": \"README.md\",\n \"pages\": {\n \"quickstarts/big-ben/README.md\": \"Quickstart: HTTP Trigger + Hosting\",\n \"quickstarts/email-users/README.md\": \"Quickstart: Auth Trigger\",\n \"quickstarts/pubsub-helloworld/README.md\": \"Quickstart: PubSub Trigger\",\n \"quickstarts/thumbnails/README.md\": \"Quickstart: Cloud Storage Trigger\",\n \"quickstarts/time-server/README.md\": \"Quickstart: HTTP Trigger\",\n \"quickstarts/uppercase/README.md\": \"Quickstart: RTDB Trigger\",\n \"quickstarts/uppercase-firestore/README.md\": \"Quickstart: Firestore Trigger\"\n },\n \"related\": [\n \"firebase/firebase-functions\"\n ]\n}\n" }, { "path": "CONTRIBUTING.md", "content": "# Contributing to the Firebase Cloud Functions Templates Library\n\nWe'd love for you to contribute to our source code and to make the Firebase\nCloud Functions Templates Library even better than it is today! Here are the\nguidelines we'd like you to follow:\n\n- [Code of Conduct](#coc)\n- [Question or Problem?](#question)\n- [Issues and Bugs](#issue)\n- [Feature Requests](#feature)\n- [Submission Guidelines](#submit)\n- [Signing the CLA](#cla)\n\n## Code of Conduct\n\nAs contributors and maintainers of the Firebase functions-samples project, we\npledge to respect everyone who contributes by posting issues, updating\ndocumentation, submitting pull requests, providing feedback in comments, and any\nother activities.\n\nCommunication through any of Firebase's channels (GitHub, StackOverflow,\nTwitter, etc.) must be constructive and never resort to personal attacks,\ntrolling, public or private harassment, insults, or other unprofessional\nconduct.\n\nWe promise to extend courtesy and respect to everyone involved in this project\nregardless of gender, gender identity, sexual orientation, disability, age,\nrace, ethnicity, religion, or level of experience. We expect anyone contributing\nto the project to do the same.\n\nIf any member of the community violates this code of conduct, the maintainers of\nthis project may take action, removing issues, comments, and PRs or blocking\naccounts as deemed appropriate.\n\nIf you are subject to or witness unacceptable behavior, or have any other\nconcerns, please drop us a line at\n[Firebase support](https://firebase.google.com/support).\n\n## Got a Question or Problem?\n\n- To report specific problems with the samples in this repository, file an\n [issue](#issue).\n- If you have questions about a sample in this repository, try opening a\n [discussion](https://github.com/firebase/functions-samples/discussions).\n- For general Cloud Functions for Firebase questions, please ask on\n [StackOverflow][stackoverflow] and use the `firebase` tag.\n- If you have a problem specific to your Firebase project, or would like to\n report an issue with Firebase itself, contact\n [Firebase support](https://firebase.google.com/support).\n\n## Found an Issue?\n\nIf you find a bug in the source code or a mistake in the documentation, you can\nhelp us by submitting an issue to our [GitHub Repository][github]. Even better,\nyou can submit a Pull Request with a fix.\n\nSee [below](#submit) for some guidelines.\n\n## Submission Guidelines\n\n### Submitting an Issue\n\nBefore you submit your issue search the archive in case your question was\nalready answered.\n\nHelp us to maximize the effort we can spend fixing issues and adding new\nfeatures by not reporting duplicate issues.\n\nThe more information you can provide in an issue, the faster we can resolve it.\nIssues that don't make an attempt to follow the issue template will likely be\nclosed.\n\n### New samples\n\nGiven the maintenance cost of the large number of samples that are already in\nthis repository, we are unlikely to add new samples. However, if you have an\nidea for a sample and would like to discuss it with others, take a look at the\n[\"ideas\" section of this repository's discussions](https://github.com/firebase/functions-samples/discussions?discussions_q=category%3AIdeas).\n\nPull Requests that contain new samples will only be considered if they meet the\nfollowing criteria:\n\n- Solve a common use-case for Cloud Functions for Firebase with minimal\n non-Firebase setup required\n- Thoroughly documented\n- Thoroughly tested\n- Simple enough to be maintained alongside all other samples in the repository\n\nIf your Pull Request isn't accepted, consider hosting it in your own GitHub\nrepository, and adding it to our\n[list of community-built extensions](./community.md)!\n\n## Signing the CLA\n\nContributions to this project must be accompanied by a Contributor License\nAgreement (CLA). You (or your employer) retain the copyright to your\ncontribution; this simply gives us permission to use and redistribute your\ncontributions as part of the project. Head over to\n to see your current agreements on file or\nto sign a new one.\n\nYou generally only need to submit a CLA once, so if you've already submitted one\n(even if it was for a different project), you probably don't need to do it\nagain.\n\nPlease sign our [Contributor License Agreement][google-cla] (CLA) before sending\npull requests. For any code changes to be accepted, the CLA must be signed. It's\na quick process, we promise!\n\n[github]: https://github.com/firebase/functions-samples\n[google-cla]: https://cla.developers.google.com\n[js-style-guide]: http://google.github.io/styleguide/javascriptguide.xml\n[py-style-guide]: http://google.github.io/styleguide/pyguide.html\n[jsbin]: http://jsbin.com/\n[stackoverflow]: http://stackoverflow.com/questions/tagged/firebase\n[global-gitignore]:\n https://help.github.com/articles/ignoring-files/#create-a-global-gitignore\n" }, { "path": "LICENSE", "content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright 2016 Google Inc.\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n" }, { "path": "Node/README.md", "content": "# Node.js (2nd gen) samples\n\nThis folder contains examples for 2nd gen Node.js functions. See a description of all samples in this folder in the [root README](../README.md)." }, { "path": "Node/alerts-to-discord/.gitignore", "content": "# Don't accidentally push Discord Webhook URL to prod\nfunctions/.env" }, { "path": "Node/alerts-to-discord/README.md", "content": "# Quickstart: Send Firebase Alerts to Discord\n\nThis quickstart demonstrates how to trigger a function based on a Firebase Alert, and send information about the alert to a channel in a Discord server.\n\n\"Screen\n\n## Set up and Deploy\n\n### Discord Webhook URL\n\nThe sample uses [Discord Webhooks](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) to send alerts to a Discord channel. You'll need to create a Webhook and hook it up the function by [creating an environment variable](https://firebase.google.com/docs/functions/config-env#env-variables):\n\n1. Follow the \"MAKING A WEBHOOK\" instructions in the [Discord docs](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks). \n1. Copy the Webhook URL\n1. Create a `.env` file in the `functions` directory\n1. Add the `DISCORD_WEBHOOK_URL` variable and set it to your Webhook URL:\n ```bash\n DISCORD_WEBHOOK_URL=\"\"\n ```\n\n### Deploy\nDeploy functions using the Firebase CLI:\n\n```bash\n$ firebase deploy\n```\n\n## License\n\n© Google, 2022. Licensed under an [Apache-2](../../../LICENSE) license.\n\n" }, { "path": "Node/alerts-to-discord/firebase.json", "content": "{\n \"functions\": {\n \"codebase\": \"alerts-to-discord\",\n \"predeploy\": [\n \"npm --prefix \\\"$RESOURCE_DIR\\\" run lint\"\n ]\n }\n}\n" }, { "path": "Node/alerts-to-discord/functions/.eslintrc.js", "content": "/**\n * Copyright 2023 Google LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nmodule.exports = {\n root: true,\n env: {\n es2017: true,\n node: true,\n },\n extends: [\n \"eslint:recommended\",\n \"google\",\n ],\n rules: {\n quotes: [\"error\", \"double\"],\n },\n};\n" }, { "path": "Node/alerts-to-discord/functions/index.js", "content": "/**\n * Copyright 2022 Google LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n// [START v2import]\n\nconst {\n onNewFatalIssuePublished,\n} = require(\"firebase-functions/alerts/crashlytics\");\nconst {\n onNewTesterIosDevicePublished,\n} = require(\"firebase-functions/alerts/appDistribution\");\nconst {\n onThresholdAlertPublished,\n} = require(\"firebase-functions/alerts/performance\");\nconst logger = require(\"firebase-functions/logger\");\n// [END v2import]\n\n/**\n * Posts a message to Discord with Discord's Webhook API\n *\n * @param {string} botName - The bot username to display\n * @param {string} messageBody - The message to post (Discord MarkDown)\n */\nasync function postMessageToDiscord(botName, messageBody) {\n const webhookUrl = process.env.DISCORD_WEBHOOK_URL;\n if (!webhookUrl) {\n throw new Error(\n \"No webhook URL found. Set the Discord Webhook URL before deploying. Learn more about Discord webhooks here: https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks\",\n );\n }\n\n return fetch(webhookUrl, {\n method: \"POST\",\n headers: {\"Content-Type\": \"application/json\"},\n body: JSON.stringify(\n // Here's what the Discord API supports in the payload:\n // https://discord.com/developers/docs/resources/webhook#execute-webhook-jsonform-params\n {\n content: messageBody,\n username: botName,\n },\n ),\n });\n}\n\n// [START v2Alerts]\n/**\n * function triggered by Crashlytics that publishes a message\n * to Discord whenever a new fatal issue occurs.\n */\n// [START v2CrashlyticsAlertTrigger]\nexports.postfatalissuetodiscord = onNewFatalIssuePublished(async (event) => {\n// [END v2CrashlyticsAlertTrigger]\n // [START v2CrashlyticsEventPayload]\n // construct a helpful message to send to Discord\n const appId = event.appId;\n const {id, title, subtitle, appVersion} = event.data.payload.issue;\n const message = `\n🚨 New fatal issue for ${appId} in version ${appVersion} 🚨\n\n**${title}**\n\n${subtitle}\n\nid: \\`${id}\\`\n`;\n // [END v2CrashlyticsEventPayload]\n\n try {\n // [START v2SendToDiscord]\n const response = await postMessageToDiscord(\"Crashlytics Bot\", message);\n if (response.ok) {\n logger.info(\n `Posted fatal Crashlytics alert ${id} for ${appId} to Discord`,\n event.data.payload,\n );\n } else {\n throw new Error(`Discord returned status code ${response.status}`);\n }\n // [END v2SendToDiscord]\n } catch (error) {\n logger.error(\n `Unable to post fatal Crashlytics alert ${id} for ${appId} to Discord`,\n error,\n );\n }\n});\n\n/**\n * function triggered by App Distribution that publishes a message\n * to Discord whenever a new iOS tester device is registered.\n */\n// [START v2AppDistributionAlertTrigger]\nexports.postnewduuidtodiscord = onNewTesterIosDevicePublished(async (event) => {\n// [END v2AppDistributionAlertTrigger]\n // [START v2AppDistributionEventPayload]\n // construct a helpful message to send to Discord\n const appId = event.appId;\n const {\n testerDeviceIdentifier,\n testerDeviceModelName,\n testerEmail,\n testerName,\n } = event.data.payload;\n const message = `\n📱 New iOS device registered by ${testerName} <${testerEmail}> for ${appId}\n\nUDID **${testerDeviceIdentifier}** for ${testerDeviceModelName}\n`;\n // [END v2AppDistributionEventPayload]\n\n try {\n // [START v2SendNewTesterIosDeviceToDiscord]\n const response = await postMessageToDiscord(\"AppDistribution Bot\", message);\n if (response.ok) {\n logger.info(\n `Posted iOS device registration alert for ${testerEmail} to Discord`,\n );\n } else {\n throw new Error(`Discord returned status code ${response.status}`);\n }\n // [END v2SendNewTesterIosDeviceToDiscord]\n } catch (error) {\n logger.error(\n `Unable to post iOS device registration for ${testerEmail} to Discord`,\n error,\n );\n }\n});\n// [END v2Alerts]\n\n/**\n * Function triggered by Firebase Performance Monitoring that publishes\n * a message to Discord whenever a performance threshold alert is fired.\n */\n// [START v2PerformanceAlertTrigger]\nexports.postperformancealerttodiscord = onThresholdAlertPublished(\n async (event) => {\n // [END v2PerformanceAlertTrigger]\n // [START v2PerformanceEventPayload]\n // construct a helpful message to send to Discord\n const appId = event.appId;\n const {\n eventName,\n metricType,\n eventType,\n numSamples,\n thresholdValue,\n thresholdUnit,\n conditionPercentile,\n appVersion,\n violationValue,\n violationUnit,\n investigateUri,\n } = event.data.payload;\n const message = `\n ⚠️ Performance Alert for ${metricType} of ${eventType}: **${eventName}** ⚠️\n \n App id: ${appId}\n Alert condition: ${thresholdValue} ${thresholdUnit}\n Percentile (if applicable): ${conditionPercentile}\n App version (if applicable): ${appVersion}\n \n Violation: ${violationValue} ${violationUnit}\n Number of samples checked: ${numSamples}\n \n **Investigate more:** ${investigateUri}\n `;\n // [END v2PerformanceEventPayload]\n\n try {\n // [START v2SendPerformanceAlertToDiscord]\n const response = await postMessageToDiscord(\n \"Firebase Performance Bot\", message);\n if (response.ok) {\n logger.info(\n `Posted Firebase Performance alert ${eventName} to Discord`,\n event.data.payload,\n );\n } else {\n throw new Error(`Discord returned status code ${response.status}`);\n }\n // [END v2SendPerformanceAlertToDiscord]\n } catch (error) {\n logger.error(\n `Unable to post Firebase Performance alert ${eventName} to Discord`,\n error,\n );\n }\n });\n// [END v2Alerts]\n" }, { "path": "Node/alerts-to-discord/functions/package.json", "content": "{\n \"name\": \"alerts-to-discord\",\n \"description\": \"Send a message to Discord when an alert is received from Firebase\",\n \"scripts\": {\n \"lint\": \"eslint .\",\n \"serve\": \"firebase emulators:start --only functions\",\n \"shell\": \"firebase functions:shell\",\n \"start\": \"npm run shell\",\n \"deploy\": \"firebase deploy --only functions\",\n \"logs\": \"firebase functions:log\",\n \"compile\": \"cp ../../../tsconfig.template.json ./tsconfig-compile.json && tsc --project tsconfig-compile.json\"\n },\n \"engines\": {\n \"node\": \"22\"\n },\n \"main\": \"index.js\",\n \"dependencies\": {\n \"firebase-admin\": \"^13.0.2\",\n \"firebase-functions\": \"7.0.0\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^17.0.45\",\n \"eslint\": \"^8.57.1\",\n \"eslint-config-google\": \"^0.14.0\",\n \"firebase-functions-test\": \"^3.4.0\"\n },\n \"private\": true\n}\n" }, { "path": "Node/app-distribution-feedback-to-jira/.eslintrc", "content": "module.exports = {\n root: true,\n env: {\n es2017: true,\n node: true,\n },\n extends: [\n \"eslint:recommended\",\n \"google\",\n ],\n rules: {\n quotes: [\"error\", \"double\"],\n },\n};\n" }, { "path": "Node/app-distribution-feedback-to-jira/.gitignore", "content": "# Logs\nlogs\n*.log\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\nfirebase-debug.log*\nfirebase-debug.*.log*\n\n# Firebase cache\n.firebase/\n\n# Firebase config\n\n# Uncomment this if you'd like others to create their own Firebase project.\n# For a team working on the same Firebase project(s), it is recommended to leave\n# it commented so all members can deploy to the same project(s) in .firebaserc.\n# .firebaserc\n\n# Runtime data\npids\n*.pid\n*.seed\n*.pid.lock\n\n# Directory for instrumented libs generated by jscoverage/JSCover\nlib-cov\n\n# Coverage directory used by tools like istanbul\ncoverage\n\n# nyc test coverage\n.nyc_output\n\n# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)\n.grunt\n\n# Bower dependency directory (https://bower.io/)\nbower_components\n\n# node-waf configuration\n.lock-wscript\n\n# Compiled binary addons (http://nodejs.org/api/addons.html)\nbuild/Release\n\n# Dependency directories\nnode_modules/\n\n# Optional npm cache directory\n.npm\n\n# Optional eslint cache\n.eslintcache\n\n# Optional REPL history\n.node_repl_history\n\n# Output of 'npm pack'\n*.tgz\n\n# Yarn Integrity file\n.yarn-integrity\n\n# dotenv environment variables file\n.env\n" }, { "path": "Node/app-distribution-feedback-to-jira/README.md", "content": "# Send in-app feedback to Jira\n \nThis [code](functions/index.js) demonstrates how to use a Firebase Cloud Function triggered by an \n[in-app feedback Firebase Alert from App Distribution](https://firebase.google.com/docs/functions/beta/reference/firebase-functions.alerts.appdistribution.inappfeedbackpayload),\nand stores the feedback details (including screenshot) in Jira.\n\nYou can customize this code to work with your own Jira configuration (eg on-premise support, custom issue types, etc). \n\n## Quickstart\n\nThis sample code uses Jira's built-in APIs to create issues for in-app tester feedback. For simplicity it uses [basic authorization](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).\n\n1. [Generate an API token](https://id.atlassian.com/manage-profile/security/api-tokens) via your Jira profile.\n\n\n Note: If the tester who files feedback does not have a Jira account, the user who generates this token will be marked as the issue's reporter.\n2. This [code](functions/index.js) uses [parameterized configuration](https://firebase.google.com/docs/functions/config-env#params) to prompt for the required configuratio. To start the process, run:\n ```bash\n $ firebase deploy\n ```\n This will store the `API_TOKEN` using [Google Cloud Secret Manager](https://cloud.google.com/secret-manager) and the remaining settings in an `.env` file which will contain the following variables, customized to your Jira project:\n ```bash\n JIRA_URI=\"\"\n PROJECT_KEY=\"\"\n ISSUE_TYPE_ID=\"\"\n ISSUE_LABEL=\"