Skip to content

Commit

Permalink
feat: Use templates from Firebase SDK's directly in the init generator (
Browse files Browse the repository at this point in the history
#222)

* Update postinstall script to add firebase templates

* Latest templates from Firebase SDK 10.10.0

* Change e2e test for lint target, firebase sdk code doesnt pass lint!

* Support the firebase SDK expiry in firestore.rules
  • Loading branch information
simondotm authored Apr 3, 2024
1 parent ff32512 commit e952ac9
Show file tree
Hide file tree
Showing 10 changed files with 205 additions and 157 deletions.
10 changes: 9 additions & 1 deletion e2e/nx-firebase-e2e/tests/test-application.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,22 @@ import {
runNxCommandAsync,
uniq,
checkFilesExist,
readFile,
} from '@nx/plugin/testing'

import {
ProjectData,
appGeneratorAsync,
cleanAppAsync,
getProjectData,
testDebug,
validateProjectConfig,
} from '../test-utils'

function expectedAppFiles(projectData: ProjectData) {
const projectPath = projectData.projectDir
return [
`${projectPath}/public/index.html`,
`${projectPath}/public/404.html`,
`${projectPath}/database.rules.json`,
`${projectPath}/firestore.indexes.json`,
`${projectPath}/firestore.rules`,
Expand All @@ -41,6 +43,12 @@ export function testApplication() {

validateProjectConfig(appData)

// check that the firestore.rules file has had the IN_30_DAYS placeholder replaced
const firestoreRules = readFile(`${appData.projectDir}/firestore.rules`)
testDebug(firestoreRules)
expect(firestoreRules).not.toContain('IN_30_DAYS')


// cleanup - app
await cleanAppAsync(appData)
})
Expand Down
3 changes: 2 additions & 1 deletion e2e/nx-firebase-e2e/tests/test-targets.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ export function testTargets() {
`nx run ${appData.projectName}:lint`,
`nx run ${functionData.projectName}:lint`,
`nx run ${functionData2.projectName}:lint`,
`All files pass linting`,
// SM March 2024: The firebase SDK templates dont pass linting !
// `All files pass linting`,
`Successfully ran target lint for 2 projects`,
`Successfully ran target lint for project ${appData.projectName}`,
])
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
{
"indexes": []
}
// Example:
//
// "indexes": [
// {
// "collectionGroup": "widgets",
// "queryScope": "COLLECTION",
// "fields": [
// { "fieldPath": "foo", "arrayConfig": "CONTAINS" },
// { "fieldPath": "bar", "mode": "DESCENDING" }
// ]
// },
//
// "fieldOverrides": [
// {
// "collectionGroup": "widgets",
// "fieldPath": "baz",
// "indexes": [
// { "order": "ASCENDING", "queryScope": "COLLECTION" }
// ]
// },
// ]
// ]
"indexes": [],
"fieldOverrides": []
}
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
rules_version = '2';
// These default Firestore rules were generated by Nx-Firebase plugin
// Change them to suit your own requirements.

// Allow read/write access on all documents to any user signed in to the application
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
allow read, write: if request.auth != null;
// This rule allows anyone with your database reference to view, edit,
// and delete all data in your database. It is useful for getting
// started, but it is configured to expire after 30 days because it
// leaves your app open to attackers. At that time, all client
// requests to your database will be denied.
//
// Make sure to write security rules for your app before that time, or
// else all client requests to your database will be denied until you
// update your rules.
allow read, write: if request.time < timestamp.date(<%= IN_30_DAYS %>);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Page Not Found</title>

<style media="screen">
body { background: #ECEFF1; color: rgba(0,0,0,0.87); font-family: Roboto, Helvetica, Arial, sans-serif; margin: 0; padding: 0; }
#message { background: white; max-width: 360px; margin: 100px auto 16px; padding: 32px 24px 16px; border-radius: 3px; }
#message h3 { color: #888; font-weight: normal; font-size: 16px; margin: 16px 0 12px; }
#message h2 { color: #ffa100; font-weight: bold; font-size: 16px; margin: 0 0 8px; }
#message h1 { font-size: 22px; font-weight: 300; color: rgba(0,0,0,0.6); margin: 0 0 16px;}
#message p { line-height: 140%; margin: 16px 0 24px; font-size: 14px; }
#message a { display: block; text-align: center; background: #039be5; text-transform: uppercase; text-decoration: none; color: white; padding: 16px; border-radius: 4px; }
#message, #message a { box-shadow: 0 1px 3px rgba(0,0,0,0.12), 0 1px 2px rgba(0,0,0,0.24); }
#load { color: rgba(0,0,0,0.4); text-align: center; font-size: 13px; }
@media (max-width: 600px) {
body, #message { margin-top: 0; background: white; box-shadow: none; }
body { border-top: 16px solid #ffa100; }
}
</style>
</head>
<body>
<div id="message">
<h2>404</h2>
<h1>Page Not Found</h1>
<p>The specified file was not found on this website. Please check the URL for mistakes and try again.</p>
<h3>Why am I seeing this?</h3>
<p>This page was generated by the Firebase Command-Line Interface. To modify it, edit the <code>404.html</code> file in your project's configured <code>public</code> directory.</p>
</div>
</body>
</html>
150 changes: 37 additions & 113 deletions packages/nx-firebase/src/generators/application/files/public/index.html
Original file line number Diff line number Diff line change
@@ -1,130 +1,55 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Welcome to Firebase Hosting</title>

<!-- update the version number as needed -->
<script defer src="/__/firebase/9.14.0/firebase-app-compat.js"></script>
<script defer src="/__/firebase/10.10.0/firebase-app-compat.js"></script>
<!-- include only the Firebase features as you need -->
<script defer src="/__/firebase/9.14.0/firebase-auth-compat.js"></script>
<script
defer
src="/__/firebase/9.14.0/firebase-database-compat.js"
></script>
<script
defer
src="/__/firebase/9.14.0/firebase-firestore-compat.js"
></script>
<script
defer
src="/__/firebase/9.14.0/firebase-functions-compat.js"
></script>
<script
defer
src="/__/firebase/9.14.0/firebase-messaging-compat.js"
></script>
<script defer src="/__/firebase/9.14.0/firebase-storage-compat.js"></script>
<script
defer
src="/__/firebase/9.14.0/firebase-analytics-compat.js"
></script>
<script
defer
src="/__/firebase/9.14.0/firebase-remote-config-compat.js"
></script>
<script
defer
src="/__/firebase/9.14.0/firebase-performance-compat.js"
></script>
<script defer src="/__/firebase/10.10.0/firebase-auth-compat.js"></script>
<script defer src="/__/firebase/10.10.0/firebase-database-compat.js"></script>
<script defer src="/__/firebase/10.10.0/firebase-firestore-compat.js"></script>
<script defer src="/__/firebase/10.10.0/firebase-functions-compat.js"></script>
<script defer src="/__/firebase/10.10.0/firebase-messaging-compat.js"></script>
<script defer src="/__/firebase/10.10.0/firebase-storage-compat.js"></script>
<script defer src="/__/firebase/10.10.0/firebase-analytics-compat.js"></script>
<script defer src="/__/firebase/10.10.0/firebase-remote-config-compat.js"></script>
<script defer src="/__/firebase/10.10.0/firebase-performance-compat.js"></script>
<!--
initialize the SDK after all desired features are loaded, set useEmulator to false
to avoid connecting the SDK to running emulators.
-->
<script defer src="/__/firebase/init.js?useEmulator=true"></script>

<style media="screen">
body {
background: #eceff1;
color: rgba(0, 0, 0, 0.87);
font-family: Roboto, Helvetica, Arial, sans-serif;
margin: 0;
padding: 0;
}
#message {
background: white;
max-width: 360px;
margin: 100px auto 16px;
padding: 32px 24px;
border-radius: 3px;
}
#message h2 {
color: #ffa100;
font-weight: bold;
font-size: 16px;
margin: 0 0 8px;
}
#message h1 {
font-size: 22px;
font-weight: 300;
color: rgba(0, 0, 0, 0.6);
margin: 0 0 16px;
}
#message p {
line-height: 140%;
margin: 16px 0 24px;
font-size: 14px;
}
#message a {
display: block;
text-align: center;
background: #039be5;
text-transform: uppercase;
text-decoration: none;
color: white;
padding: 16px;
border-radius: 4px;
}
#message,
#message a {
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.12), 0 1px 2px rgba(0, 0, 0, 0.24);
}
#load {
color: rgba(0, 0, 0, 0.4);
text-align: center;
font-size: 13px;
}
body { background: #ECEFF1; color: rgba(0,0,0,0.87); font-family: Roboto, Helvetica, Arial, sans-serif; margin: 0; padding: 0; }
#message { background: white; max-width: 360px; margin: 100px auto 16px; padding: 32px 24px; border-radius: 3px; }
#message h2 { color: #ffa100; font-weight: bold; font-size: 16px; margin: 0 0 8px; }
#message h1 { font-size: 22px; font-weight: 300; color: rgba(0,0,0,0.6); margin: 0 0 16px;}
#message p { line-height: 140%; margin: 16px 0 24px; font-size: 14px; }
#message a { display: block; text-align: center; background: #039be5; text-transform: uppercase; text-decoration: none; color: white; padding: 16px; border-radius: 4px; }
#message, #message a { box-shadow: 0 1px 3px rgba(0,0,0,0.12), 0 1px 2px rgba(0,0,0,0.24); }
#load { color: rgba(0,0,0,0.4); text-align: center; font-size: 13px; }
@media (max-width: 600px) {
body,
#message {
margin-top: 0;
background: white;
box-shadow: none;
}
body {
border-top: 16px solid #ffa100;
}
body, #message { margin-top: 0; background: white; box-shadow: none; }
body { border-top: 16px solid #ffa100; }
}
</style>
</head>
<body>
<div id="message">
<h2>Welcome</h2>
<h1>Firebase Hosting Setup Complete</h1>
<p>
You're seeing this because you've successfully setup Firebase Hosting.
Now it's time to go build something extraordinary!
</p>
<a target="_blank" href="https://firebase.google.com/docs/hosting/"
>Open Hosting Documentation</a
>
<p>You're seeing this because you've successfully setup Firebase Hosting. Now it's time to go build something extraordinary!</p>
<a target="_blank" href="https://firebase.google.com/docs/hosting/">Open Hosting Documentation</a>
</div>
<p id="load">Firebase SDK Loading&hellip;</p>

<script>
document.addEventListener('DOMContentLoaded', function () {
const loadEl = document.querySelector('#load')
document.addEventListener('DOMContentLoaded', function() {
const loadEl = document.querySelector('#load');
// // 🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥
// // The Firebase SDK is initialized and available here!
//
Expand All @@ -141,25 +66,24 @@ <h1>Firebase Hosting Setup Complete</h1>
// // 🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥

try {
let app = firebase.app()
let app = firebase.app();
let features = [
'auth',
'database',
'auth',
'database',
'firestore',
'functions',
'messaging',
'storage',
'analytics',
'messaging',
'storage',
'analytics',
'remoteConfig',
'performance',
].filter((feature) => typeof app[feature] === 'function')
loadEl.textContent = `Firebase SDK loaded with ${features.join(', ')}`
].filter(feature => typeof app[feature] === 'function');
loadEl.textContent = `Firebase SDK loaded with ${features.join(', ')}`;
} catch (e) {
console.error(e)
loadEl.textContent =
'Error loading the Firebase SDK, check the console.'
console.error(e);
loadEl.textContent = 'Error loading the Firebase SDK, check the console.';
}
})
});
</script>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
// replace this file with your own firebase storage rules
rules_version = '2';

// Craft rules based on data in your Firestore database
// allow write: if firestore.get(
// /databases/(default)/documents/users/$(request.auth.uid)).data.isAdmin;
service firebase.storage {
match /b/{bucket}/o {
match /{allPaths=**} {
allow read, write: if request.auth != null;
allow read, write: if false;
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,23 @@ import type { NormalizedSchema } from '../schema'
export function createFiles(tree: Tree, options: NormalizedSchema): void {
const firebaseAppConfig = options.firebaseConfigName

// Firebase SDK firestore.rules template has a placeholder for the date 30 days from now
// so we add that substitution here at the point of app generation
const date = new Date()
date.setDate(date.getDate() + 30)
const dateString = date
.toISOString()
.split('T')[0]
.split('-')
.map((v) => parseInt(v).toString())
.join(', ')

const substitutions = {
tmpl: '',
projectName: options.projectName,
projectRoot: options.projectRoot,
firebaseAppConfig,
IN_30_DAYS: dateString,
}

// The default functions package.json & templated typescript source files are added here
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,10 @@
import {onRequest} from "firebase-functions/v2/https";
import * as logger from "firebase-functions/logger";

// import { initializeApp } from "firebase-admin/app";
// initializeApp()

// Start writing functions
// https://firebase.google.com/docs/functions/typescript

export const helloWorld = onRequest((request, response) => {
logger.info("Hello logs!", {structuredData: true});
response.send("Hello from Firebase!");
});
// export const helloWorld = onRequest((request, response) => {
// logger.info("Hello logs!", {structuredData: true});
// response.send("Hello from Firebase!");
// });
Loading

0 comments on commit e952ac9

Please sign in to comment.