Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Promote dev #418

Merged
merged 9 commits into from
Feb 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,44 @@
# Changelog

## [3.6.0-1](https://github.com/agrc/plss/compare/v3.5.20...v3.6.0-1) (2025-02-06)


### Features

* **api:** migrate to v2 functions and triggers ([f544082](https://github.com/agrc/plss/commit/f544082dbecc0a75258e6a0467f6b45c54f99a59))


### Bug Fixes

* **api:** replace undefined as its not a valid type ([ce5d3b5](https://github.com/agrc/plss/commit/ce5d3b53550ba888895c2074388fe984f8499983))
* correct a bug where files uploaded with periods break the preview ([682ca0b](https://github.com/agrc/plss/commit/682ca0b12985afc26320156a46f1ca833d3e9667))
* correct login avatar fallback missing image ([60034f2](https://github.com/agrc/plss/commit/60034f248e8ed3ee5516e6379322527fa8acb2ef))
* update to node.js 22 runtime ([ca2e29f](https://github.com/agrc/plss/commit/ca2e29f736ab1fe4059485ea06cccfae396f9bcc))


### Styles

* add missing bg to text areas ([7f232ac](https://github.com/agrc/plss/commit/7f232ac62b8b1f6d4067f1431b924b5e8093c723))

## [3.6.0-0](https://github.com/agrc/plss/compare/v3.5.20...v3.6.0-0) (2025-02-06)


### Features

* **api:** migrate to v2 functions and triggers ([532ef1c](https://github.com/agrc/plss/commit/532ef1c2592b927f9f29397968eeb400bc2e55cc))


### Bug Fixes

* **api:** replace undefined as its not a valid type ([ce5d3b5](https://github.com/agrc/plss/commit/ce5d3b53550ba888895c2074388fe984f8499983))
* correct a bug where files uploaded with periods break the preview ([682ca0b](https://github.com/agrc/plss/commit/682ca0b12985afc26320156a46f1ca833d3e9667))
* correct login avatar fallback missing image ([60034f2](https://github.com/agrc/plss/commit/60034f248e8ed3ee5516e6379322527fa8acb2ef))


### Styles

* add missing bg to text areas ([7f232ac](https://github.com/agrc/plss/commit/7f232ac62b8b1f6d4067f1431b924b5e8093c723))

## [3.5.20](https://github.com/agrc/plss/compare/v3.5.19...v3.5.20) (2025-02-05)


Expand Down
2 changes: 1 addition & 1 deletion firebase.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"functions": [
{
"source": "functions",
"runtime": "nodejs20",
"runtime": "nodejs22",
"codebase": "default",
"ignore": ["node_modules", ".git", "firebase-debug.log", "firebase-debug.*.log"]
}
Expand Down
2 changes: 1 addition & 1 deletion functions/auth/onCreate.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { logger } from 'firebase-functions/v1';
import { logger } from 'firebase-functions/v2';
import { getFirestore } from 'firebase-admin/firestore';

const db = getFirestore();
Expand Down
2 changes: 1 addition & 1 deletion functions/database/submissions/onCancelSubmission.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { logger } from 'firebase-functions/v1';
import { logger } from 'firebase-functions/v2';
import { getFirestore } from 'firebase-admin/firestore';
import { safelyInitializeApp } from '../../firebase.js';
import { getContactsToNotify, notify } from '../../emailHelpers.js';
Expand Down
4 changes: 3 additions & 1 deletion functions/database/submissions/onCreateAddLocation.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { logger } from 'firebase-functions/v1';
import { logger } from 'firebase-functions/v2';
import { getFirestore, GeoPoint } from 'firebase-admin/firestore';
import ky from 'ky';
import { safelyInitializeApp } from '../../firebase.js';
Expand All @@ -8,6 +8,8 @@ safelyInitializeApp();
const client = ky.extend({
prefixUrl:
'https://services1.arcgis.com/99lidPhWCzftIe9K/arcgis/rest/services',
timeout: 30000,
retry: 3,
});

const getLocationFromId = async (id) => {
Expand Down
2 changes: 1 addition & 1 deletion functions/database/submissions/onCreateMonument.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { logger } from 'firebase-functions/v1';
import { logger } from 'firebase-functions/v2';
import { getFirestore } from 'firebase-admin/firestore';
import { getStorage } from 'firebase-admin/storage';
import {
Expand Down
2 changes: 1 addition & 1 deletion functions/emailHelpers.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import client from '@sendgrid/client';
import { Base64Encode } from 'base64-stream';
import { logger } from 'firebase-functions/v1';
import { logger } from 'firebase-functions/v2';

export const notify = (key, template) => {
if (process.env.NODE_ENV !== 'production') {
Expand Down
2 changes: 1 addition & 1 deletion functions/https/getMyContent.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { logger } from 'firebase-functions/v1';
import { logger } from 'firebase-functions/v2';
import { getFirestore } from 'firebase-admin/firestore';
import { graphicConverter, myContentConverter } from '../converters.js';
import { safelyInitializeApp } from '../firebase.js';
Expand Down
2 changes: 1 addition & 1 deletion functions/https/getMyProfile.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { https, logger } from 'firebase-functions/v1';
import { https, logger } from 'firebase-functions/v2';
import { getFirestore } from 'firebase-admin/firestore';
import { safelyInitializeApp } from '../firebase.js';

Expand Down
2 changes: 1 addition & 1 deletion functions/https/postCancelCorner.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { https, logger } from 'firebase-functions/v1';
import { https, logger } from 'firebase-functions/v2';
import { getFirestore } from 'firebase-admin/firestore';
import { getStorage } from 'firebase-admin/storage';
import { safelyInitializeApp } from '../firebase.js';
Expand Down
6 changes: 3 additions & 3 deletions functions/https/postCorner.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { https, logger } from 'firebase-functions/v1';
import { https, logger } from 'firebase-functions/v2';
import { getFirestore, GeoPoint } from 'firebase-admin/firestore';
import { parseDms } from 'dms-conversion';
import * as schemas from '../shared/cornerSubmission/Schema.js';
Expand Down Expand Up @@ -159,7 +159,7 @@ export const formatNewCorner = (data, metadata) => {
zone: data.grid.zone,
unit: data.grid.unit,
elevation: data.grid.elevation,
verticalDatum: data.grid.verticalDatum,
verticalDatum: data.grid.verticalDatum ?? null,
},
geographic: {
northing: {
Expand Down Expand Up @@ -208,7 +208,7 @@ export const formatExistingCorner = (data, metadata) => {
zone: data.grid.zone,
unit: data.grid.unit,
elevation: data.grid.elevation,
verticalDatum: data.grid.verticalDatum,
verticalDatum: data.grid.verticalDatum ?? null,
},
geographic: {
northing: {
Expand Down
2 changes: 1 addition & 1 deletion functions/https/postGeneratePreview.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { getFirestore } from 'firebase-admin/firestore';
import { getStorage } from 'firebase-admin/storage';
import { https, logger } from 'firebase-functions/v1';
import { https, logger } from 'firebase-functions/v2';
import {
createPdfDocument,
generatePdfDefinition,
Expand Down
2 changes: 1 addition & 1 deletion functions/https/postProfile.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { https, logger } from 'firebase-functions/v1';
import { https, logger } from 'firebase-functions/v2';
import { getFirestore } from 'firebase-admin/firestore';
import { profileSchema } from '../shared/cornerSubmission/Schema.js';
import { safelyInitializeApp } from '../firebase.js';
Expand Down
119 changes: 69 additions & 50 deletions functions/index.js
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
import { logger } from 'firebase-functions/v2';
import {
auth,
logger,
firestore,
runWith,
storage,
} from 'firebase-functions/v1'; // v2 does not support auth triggers as of july/23
onDocumentUpdated,
onDocumentCreated,
onDocumentDeleted,
} from 'firebase-functions/v2/firestore';
import {
onObjectFinalized,
onObjectDeleted,
} from 'firebase-functions/v2/storage';
import { beforeUserCreated } from 'firebase-functions/v2/identity';
import { https } from 'firebase-functions/v2';
import { safelyInitializeApp } from './firebase.js';
import { defineSecret } from 'firebase-functions/params';
import { safelyInitializeApp } from './firebase.js';

const cors = [
/localhost/,
/ut-dts-agrc-web-api-dev-self-service\.web\.app$/,
/ut-dts-agrc-plss-dev\.web\.app$/,
/plss\.(?:dev\.)?utah\.gov/,
];

Expand All @@ -35,27 +39,32 @@ const config = safelyInitializeApp();
const sendGridApiKey = defineSecret('SENDGRID_API_KEY');

// Firebase authentication
export const onCreateUser = auth.user().onCreate(async (user) => {
export const onCreateUser = beforeUserCreated(async (event) => {
logger.debug('[auth::user::onCreate] importing createUser');
const createUser = (await import('./auth/onCreate.js')).createUser;

const result = await createUser(user);
const result = await createUser(event.data);

logger.debug('[auth::user::onCreate]', result);

return result;
});

// Firestore triggers
export const onCancelSubmission = runWith({ secrets: [sendGridApiKey] })
.firestore.document('/submissions/{docId}')
.onUpdate(async (change, context) => {
const current = change.after.get('status.user.cancelled');
const previous = change.before.get('status.user.cancelled');
export const onCancelSubmission = onDocumentUpdated(
{
document: '/submissions/{docId}',
secrets: [sendGridApiKey],
},
async (event) => {
const after = event.data.after.data();
const current = after.status.user.cancelled;
const before = event.data.before.data();
const previous = before.status.user.cancelled;

logger.debug(
'[database::submissions::onCancel] trigger: submission document updated',
context.params.docId,
event.params.docId,
{
structuredData: true,
},
Expand Down Expand Up @@ -99,17 +108,18 @@ export const onCancelSubmission = runWith({ secrets: [sendGridApiKey] })
structuredData: true,
});

const result = await cancelSubmission(change.before);
const result = await cancelSubmission(event.data.before);

logger.debug('[database::submissions::onCancel]', result);

return result;
});
},
);

export const onCreateAddLocation = firestore
.document('/submissions/{docId}')
.onCreate(async (snap, context) => {
const record = snap.data();
export const onCreateAddLocation = onDocumentCreated(
'/submissions/{docId}',
async (event) => {
const record = event.data.data();

if (record.type === 'new') {
logger.debug(
Expand Down Expand Up @@ -143,23 +153,27 @@ export const onCreateAddLocation = firestore
);

const result = await createAddLocation(
context.params.docId,
event.params.docId,
record.blm_point_id,
);

logger.debug('[database::submissions::onCreateAddLocation]', result);

return result;
});
},
);

export const onCreateMonumentRecord = runWith({ memory: '512MB' })
.firestore.document('/submissions/{docId}')
.onCreate(async (snap, context) => {
const record = snap.data();
export const onCreateMonumentRecord = onDocumentCreated(
{
document: '/submissions/{docId}',
memory: '512MiB',
},
async (event) => {
const record = event.data.data();

logger.debug(
'[database::submissions::onCreateMonumentRecord] trigger: new submission for',
context.params.docId,
event.params.docId,
record.type,
{
structuredData: true,
Expand All @@ -173,21 +187,22 @@ export const onCreateMonumentRecord = runWith({ memory: '512MB' })
await import('./database/submissions/onCreateMonument.js')
).createMonumentRecord;

const result = await createMonumentRecord(record, context.params.docId);
const result = await createMonumentRecord(record, event.params.docId);

logger.debug('[database::submissions::onCreateMonumentRecord]', result);

return result;
});
},
);

export const onCleanUpPointAttachments = firestore
.document('/submitters/{userId}/points/{docId}')
.onDelete(async (snap, context) => {
const record = snap.data();
export const onCleanUpPointAttachments = onDocumentDeleted(
'/submitters/{userId}/points/{docId}',
async (event) => {
const record = event.data.data();

logger.debug(
'[database::submitters::onCleanUpPointAttachments] trigger: point deleted',
context,
event,
record,
{
structuredData: true,
Expand Down Expand Up @@ -222,7 +237,8 @@ export const onCleanUpPointAttachments = firestore
logger.debug('[database::submissions::onCleanUpPointAttachments]', result);

return result;
});
},
);

// HTTPS triggers
export const getMyContent = https.onCall({ cors }, async (request) => {
Expand Down Expand Up @@ -289,7 +305,7 @@ export const postCorner = https.onCall({ cors }, async ({ data, auth }) => {
});

export const postGeneratePreview = https.onCall(
{ cors, memory: '512MB' },
{ cors, memory: '512MiB' },
async ({ data, auth }) => {
logger.debug('[https::postGeneratePreview] starting');

Expand Down Expand Up @@ -335,11 +351,13 @@ export const postProfile = https.onCall(async ({ data, auth }) => {
});

// Storage triggers
export const onCreateNotify = runWith({ secrets: [sendGridApiKey] })
.storage.bucket(config.storageBucket)
.object()
.onFinalize(async (object) => {
const { name, contentType, bucket: fileBucket } = object;
export const onCreateNotify = onObjectFinalized(
{
secrets: [sendGridApiKey],
bucket: config.storageBucket,
},
async (event) => {
const { name, contentType, bucket: fileBucket } = event.data;

logger.debug(
'[storage::finalize::onCreateNotify] trigger: storage object created',
Expand Down Expand Up @@ -382,13 +400,13 @@ export const onCreateNotify = runWith({ secrets: [sendGridApiKey] })
logger.debug('[storage::finalize::onCreateNotify]', result);

return result;
});
},
);

export const syncProfileImage = storage
.bucket(config.storageBucket)
.object()
.onDelete(async (object) => {
const { name } = object;
export const syncProfileImage = onObjectDeleted(
{ bucket: config.storageBucket },
async (event) => {
const { name } = event.data;

logger.debug(
'[storage::onDelete::syncProfileImage] trigger: storage object deleted',
Expand Down Expand Up @@ -421,4 +439,5 @@ export const syncProfileImage = storage
logger.debug('[storage::onDelete::syncProfileImage]', result);

return result;
});
},
);
2 changes: 1 addition & 1 deletion functions/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion functions/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@
"semi": true
},
"engines": {
"node": "20"
"node": "22"
}
}
Loading