Reputation: 10384
How can an async
helper method be added to a Cloud Functions' index.js file? An async
function is required in order to use await
when converting fs.writefile
into a Promise as explained in this StackOverflow post: fs.writeFile in a promise, asynchronous-synchronous stuff. However, lint does not approve of adding an additional method outside of the exports
functions to the index.js file.
Line 84 refers to the helper function async function writeFile
.
Users/adamhurwitz/coinverse/coinverse-cloud-functions/functions/index.js 84:7 error Parsing error: Unexpected token function
✖ 1 problem (1 error, 0 warnings)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! functions@ lint:
eslint .
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the functions@ lint script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
npm ERR! A complete log of this run can be found in:
npm ERR! /Users/adamhurwitz/.npm/_logs/2018-12-12T01_47_50_684Z-debug.log
Error: functions predeploy error: Command terminated with non-zero exit code1
index.js
const path = require('path');
const os = require('os');
const fs = require('fs');
const fsPromises = require('fs').promises;
const util = require('util');
const admin = require('firebase-admin');
const functions = require('firebase-functions');
const {Storage} = require('@google-cloud/storage');
const textToSpeech = require('@google-cloud/text-to-speech');
const storage = new Storage({
projectId: 'project-id',
});
const client = new textToSpeech.TextToSpeechClient();
admin.initializeApp();
exports.getAudiocast = functions.https.onCall((data, context) => {
const bucket = storage.bucket('gs://[bucket-name].appspot.com');
var fileName;
var tempFile;
var filePath;
return client.synthesizeSpeech({
input: {text: data.text },
voice: {languageCode: 'en-US', ssmlGender: 'NEUTRAL'},
audioConfig: {audioEncoding: 'MP3'},
})
.then(responses => {
var response = responses[0];
fileName = data.id + '.mp3'
tempFile = path.join(os.tmpdir(), fileName);
return writeFile(tempFile, response.audioContent)
})
.catch(err => {
console.error("Synthesize Speech Error: " + err);
})
.then(() => {
filePath = "filePath/" + fileName;
return bucket.upload(tempFile, { destination: filePath })
})
.catch(err => {
console.error("Write Temporary Audio File Error: " + err);
})
.then(() => {
return { filePath: filePath }
})
.catch(err => {
console.error('Upload Audio to GCS ERROR: ' + err);
});
});
Helper method:
async function writeFile(tempFile, audioContent) {
await fs.writeFile(tempFile, audioContent, 'binary');
}
Enabling Node.js 8 as recommended in the post Cloud Functions for Firebase Async Await style.
Set Node.js version
"engines": {"node": "8"}
return await fs.writeFile(tempFile, audioContent, 'binary');
Lint does not like this solution.
Upvotes: 23
Views: 17837
Reputation: 31
I ran into the same issue.
I used the same ESLint configuration as used in one of the functions in the Firebase functions samples GitHub repo. I referred to this particular example here: https://github.com/firebase/functions-samples/tree/main/child-count, which makes use of async functions.
I removed the eslintrc.js and replaced it with the same eslintrc.json file as in the above sample. Also, in package.json, added a new dependency "eslint-plugin-promise": "^4.3.1"
, and removed the default "eslint-config-google": "^0.14.0"
(Again, as is in the above sample).
This seems to have fixed it for me.
Upvotes: 0
Reputation: 1717
If you have .eslint.js
- just change es6: true
to es2017: true
.
For example:
env: {
es6: true,
node: true,
},
becomes:
env: {
es2017: true,
node: true,
},
More details in ESLint language options doc.
Upvotes: 14
Reputation: 169
you have to check on your .eslintrc that you have at least es8 or 2017 which is the same.
if the file is .eslintrc.json
"ecmaVersion": 2017 or "ecmaVersion": 8
if the file is .eslintrc.js
env:{ es8:true, node:true }
for some it works that way
"scripts": { "lint": "eslint ." },
changed to :
"scripts": { "lint": "eslint" },
as Jonathan Said but I wonder why?
and a realized that I had two files with the name
and
as you can see there are diferent versions of ecmaScript in the two files with the same name,
so when we run : npm run lint it runs the .eslintrc.js with es6:true so to solve this conflict was just to delete .eslintrc.js because it has the wrong ecmaScript.
Upvotes: 15
Reputation: 2148
I tried all solutions above which did not work for me. It was due to bad syntax in my package.json :
"scripts": {
"lint": "eslint ."
},
changed to :
"scripts": {
"lint": "eslint"
},
Like said Burak in the comments, this dot is put by default when we create firebase functions
Upvotes: 156
Reputation: 1
.eslint.json
"parserOptions": { // Required for certain syntax usages "ecmaVersion": 6 }, Change it like this to help it understand async/await:
"ecmaVersion": 2017
package.json "scripts": { "lint": "eslint ." }, changed to :
"scripts": { "lint": "eslint" },
Refereces Captain Web and Doug Stevenson
Upvotes: -1
Reputation: 317
change ecmaVersion in .eslintrc.json
"parserOptions": {
// Required for certain syntax usages
"ecmaVersion": 8
}
Upvotes: 0
Reputation: 317750
Your eslint is not configured to understand ECMAScript 2017 syntax. The .eslint.json config file that's created by the Fireabse CLI by default includes this configuration:
"parserOptions": {
// Required for certain syntax usages
"ecmaVersion": 6
},
Change it like this to help it understand async/await:
"ecmaVersion": 2017
Upvotes: 20
Reputation: 10384
Enabling Node.js 8 as recommended in the post Cloud Functions for Firebase Async Await style.
"engines": {"node": "8"}
Use promisify
const writeFile = util.promisify(fs.writeFile);
return writeFile(tempFile, response.audioContent, 'binary')
This is an older approach to convert Callbacks to Promises as outlined by this answer regarding a more specific question about Google Text To Speech (TTS).
const writeFilePromise = (file, data, option) => {
return new Promise((resolve, reject) => {
fs.writeFile(file, data, option, error => {
if (error) reject(error);
resolve("File created! Time for the next step!");
});
});
};
return writeFilePromise(tempFile, response.audioContent, 'binary');
Upvotes: 2