GCLOUD_PROJECT environment variable missing from the Node 10 runtime

[peterpeterparker]

[REQUIRED] Version info

node:
Node v10

[REQUIRED] Steps to reproduce

I have upgraded my functions from Node v8 to Node v10. Compilation as upload in the cloud are ok but I face an error at runtime, respectively GCLOUD_PROJECT is not found/set

Here the stack trace of the error I found in the Firebase console:

Error: process.env.GCLOUD_PROJECT is not set.
    at DocumentBuilder (/srv/functions/node_modules/firebase-functions/lib/providers/firestore.js:99:23)
    at cloudFunctionNewSignature (/srv/functions/node_modules/firebase-functions/lib/cloud-functions.js:102:13)
    at cloudFunction (/srv/functions/node_modules/firebase-functions/lib/cloud-functions.js:151:20)
    at Promise.resolve.then (/srv/node_modules/@google-cloud/functions-framework/build/src/invoker.js:330:28)
    at process._tickCallback (internal/process/next_tick.js:68:7)

When I downgrade back to Node v8, I do not face that error.

Were you able to successfully deploy your functions?

Yes

[google-oss-bot]

I found a few problems with this issue:

• I couldn't figure out how to label this issue, so I've labeled it for a human to triage. Hang tight.
• This issue does not seem to follow the issue template. Make sure you provide all the required information.

[thechenky]

Hi @peterpeterparker thanks for opening up the new issue. Can you provide a snippet of your functions code?

[peterpeterparker]

sure @thechenky here you go:

import {CollectionReference, DocumentSnapshot, QuerySnapshot, DocumentReference} from '@google-cloud/firestore';

import * as admin from 'firebase-admin';

import {Change, EventContext} from 'firebase-functions';

export async function applyUsersUpdate(change: Change<DocumentSnapshot>, context: EventContext) {
    const newValue: any = change.after.data() as any;

    const previousValue: any = change.before.data() as any;

    if (!newValue || !previousValue || newValue.my_field === previousValue.my_field) {
        return;
    }

    try {
        await myUpdateMethod(change, newValue);
    } catch (err) {
        console.error(err);
    }
}

[thechenky]

Hm, I would expect to see something calling Firestore to set the value (since the error is coming from here: firebase-functions/lib/providers/firestore.js:99:23). Is that in the myUpdateMethod? Would you mind pasting that too?

[thechenky]

This is almost certainly due to GCLOUD_PROJECT env var no longer being populated in the Node 10 runtime. Are you deploying your functions using the Firebase CLI? I'm thinking maybe we can set that environment when we deploy your functions as a stopgap.

[MaximBazarov]

@thechenky in my case it's

exports.UpdateCountriesValues = functions.firestore
    .document(COUNTRIES_COLLECTION + '/{needsValues}')
    .onWrite(async (change, context) => {
        try {
            const id = await getID(change);
            return updateValues(id, COUNTRIES_COLLECTION);
        }
        catch (e) {
            return e;
        }
    });


async function updateValues(id, collection) {
    const token = await authRequest();
    const values = await makeRequest(valuesRequest(token, id));
    const batch = db.batch();
    let years = [];
    values.forEach((value) => {
        years.push(value.year.toString());
        const collectionName = collection + "-values";
        let record = Values(value);
        const valueRef = db
            .collection(collectionName)
            .doc(id.toString() + "-" + value.year.toString());
        batch.set(valueRef, record);
        if (collection === COUNTRIES_COLLECTION) {
            const countryCapitalRef = db
                .collection(COUNTRIES_COLLECTION)
                .doc(id.toString());
            batch.set(countryCapitalRef, {
                en: {
                    capital: value.report_type_eng,
                },
                ru: {
                    capital: value.report_type,
                }
            }, { merge: true });
        }
    });
    years.forEach((year) => {
        const yearRef = db
            .collection(YEARS_COLLECTION)
            .doc(year.toString());
        batch.set(yearRef, { year: year });
    });
    const objectRef = db
        .collection(collection)
        .doc(id.toString());
    batch.set(objectRef, {
        "needsValues": false,
    }, { "merge": true });
    await batch.commit();
    return id;
}

I'm deploying using the Firebase CLI

[thechenky]

Ah yes, this confirms it then. Thank you for sharing your code! This is definitely a bug on our side with Node 10. I will make a note of this and try to get a fix out - I'll need to think on the best way to implement it though, so that might take a bit of time. The absence of this env variable impacts most event source providers, not just Firestore like in your case, so we need to be careful on how we go about fixing this. In the mean time, please use Node 8. I'll make sure to post any updates to this thread periodically.

[peterpeterparker]

Thx @MaximBazarov for the code, you were faster than me 😉

@thechenky thx for having a look at the problem and if you still need the example of code from my side or a tester, for sure let me know

[thechenky]

Quick update: Node 10 runtime is the first runtime to not have the GCLOUD_PROJECT environment variable automatically set. Because the firebase functions SDK relies on this env var for most of its event provider code, we need to figure out the best way to get this GCLOUD_PROJECT value set. Meanwhile, please continue using Node 8 until this issue is fixed.

[kdawgwilk]

Is there a different workaround for those that need to use Node 10 runtime? I am using GitHub Actions to auto deploy my projects changes on push and the GitHub NPM action uses a Node 10 container and so if I drop the "engines" to 8 it breaks my CI flow