Can't debug with firebase tools 6.10.0 in vs code due to unverified breakpoints #1360

ke-nzo · 2019-06-02T17:59:31Z

[REQUIRED] Environment info

firebase-tools: 6.10.0

Platform:macOs, Windows

[REQUIRED] Test case

launching attach to debug from launch.json, breakpoint will result all unverified with no possibility to stop in

[REQUIRED] Steps to reproduce

"version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "attach",
      "name": "Attach by Process ID",
      "processId": "${command:PickProcess}"
    }
  ]
}

simply run Attach by Process ID, and breakpoints will result in grey unverified.

[REQUIRED] Expected behavior

breakpoint must to remain red for stop in and debug

[REQUIRED] Actual behavior

breakpoint remain grey after debug launched

i'd like to add that i have tested debug with firebase-tools 6.3.0 and attach to process perfectly work. with 6.10.0 doesn't.

google-oss-bot · 2019-06-02T17:59:32Z

This issue does not have all the information required by the template. Looks like you forgot to fill out some sections. Please update the issue with more information.

thechenky · 2019-06-02T20:38:32Z

@vincy261 this seems like an issue with VSCode and not firebase tools. I would try asking on channels like StackOverflow to get the support you need.

ke-nzo · 2019-06-03T08:02:13Z

HI @thechenky , i have tested debug with firebase-tools 6.3.0 and attach to process perfectly work. with 6.10.0 doesn't. Same VS code

samtstern · 2019-06-03T15:48:16Z

Thanks @vincy261. I think @abeisgoat knows more about this. The new emulator (in versions 6.9.0 and above) runs the functions in a separate process which probably needs to expose some more information to be debuggable.

abeisgoat · 2019-06-03T17:14:56Z

Hey @vincy261, can you provide a detailed step-by-step example of how to reproduce this? I have no familiarity with VS Code or how the debugging works, so I'll need something like...

Make a new folder
Put XXX in index.js
Put a breakpoint by doing X
Run the code by doing this...
Etc, etc

I have no idea what's expected so I can't really help until I have that info. As Sam said, we did switch how we run functions, so it's expected that this could break.

ke-nzo · 2019-06-03T18:10:17Z

Hi @abeisgoat , sure i can, so:

Create a new firebase project with typescript
Write a simple index.ts and export your cloud function testFunction and set it in the firebase.json

import * as express from 'express';
import * as functions from 'firebase-functions';

const app = express();

app.head('/', (req, res) => res.sendStatus(204))

app.get('/timestamp', (req, res) => {
  res.send(`${Date.now()}`);
})

export const testFunction = functions.https.onRequest(app);

console.log('started')

add this to the launch.json (launch json is the debug settings file for VS code integrated debug tool usually the third icon on the side bar menu)

"version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "attach",
      "name": "Attach by Process ID",
      "processId": "${command:PickProcess}"
    }
  ]
}

run tsc (typescript compiler) and the local emulator

tsc
firebase serve --only functions

now press F1 it will open the command menu and type: debug: Attach by Process ID
usually is the first process. Now your bottom bar from blue should turn orange
at this point you will notice that if you put a breakpoint on:

res.send(`${Date.now()}`);

the breakpoint doesn't turn red but grey and it will say "unverified breakpoint" thus calling timestamp endpoint in the browser it won't stop on the line.

instead repeat the test with [email protected] (or at least prior to 6.9.0) and it will work!

abeisgoat · 2019-06-03T19:01:25Z

Fantastic, thanks for the thorough and quick response, I'll take a look at this when I get some time and report back!

abeisgoat · 2019-06-07T20:13:36Z

So I've looked into this a bit and it seems like it's going to be tricky. If we changed how the emulator works to solve #1353 it would also make this easier, so this is an argument in favor of changing that system.

sultanmyrza · 2019-07-25T05:41:04Z

6.3.0

Hi @abeisgoat , sure i can, so:

Create a new firebase project with typescript

Write a simple index.ts and export your cloud function testFunction and set it in the firebase.json
import * as express from 'express';
import * as functions from 'firebase-functions';

const app = express();

app.head('/', (req, res) => res.sendStatus(204))

app.get('/timestamp', (req, res) => {
  res.send(`${Date.now()}`);
})

export const testFunction = functions.https.onRequest(app);

console.log('started')
add this to the launch.json (launch json is the debug settings file for VS code integrated debug tool usually the third icon on the side bar menu)
"version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "attach",
      "name": "Attach by Process ID",
      "processId": "${command:PickProcess}"
    }
  ]
}     
run tsc (typescript compiler) and the local emulator
tsc
firebase serve --only functions
now press F1 it will open the command menu and type: debug: Attach by Process ID
usually is the first process. Now your bottom bar from blue should turn orange

at this point you will notice that if you put a breakpoint on:
res.send(`${Date.now()}`);
the breakpoint doesn't turn red but grey and it will say "unverified breakpoint" thus calling timestamp endpoint in the browser it won't stop on the line.

instead repeat the test with [email protected] (or at least prior to 6.9.0) and it will work!

when install [email protected] it gives warning

sudo npm i -g [email protected]
npm WARN deprecated @google-cloud/[email protected]: Deprecating in favor of the Functions Framework and firebase-tools. See googlearchive/cloud-functions-emulator#327
/usr/local/bin/firebase -> /usr/local/lib/node_modules/firebase-tools/lib/bin/firebase.js

@google-cloud/[email protected] postinstall /usr/local/lib/node_modules/firebase-tools/node_modules/@google-cloud/functions-emulator
node scripts/upgrade-warning

If you're using the Emulator via the Firebase CLI, you can
disregard this message.

If you're upgrading @google-cloud/functions-emulator, these
are the recommended upgrade steps:

Stop the currently running emulator, if any:
```
functions stop
```

Uninstall the current emulator, if any:

npm uninstall -g @google-cloud/functions-emulator

Install the new version of the emulator:

npm install -g @google-cloud/functions-emulator

If you have trouble after upgrading, try deleting the config
directory found in:

~/.config/configstore/@google-cloud/functions-emulator

Then restart the emulator. You can also check for any renegade
Node.js emulator processes that may need to be killed:

ps aux | grep node

[email protected]

vongohren · 2019-09-21T14:42:34Z

@vincy261 so you are saying you are getting the connection up, but the breakpoints are not verified?

I would love to see some documentation on how to set it up, maybe towards the chrome debugger as well. Not just VS code

@sultanmyrza not sure why you are posting stuff about a deprecated library?

goleary · 2019-11-20T21:58:32Z

as @jimmont mentioned on #517
you can use https://www.npmjs.com/package/ndb to place breakpoints in your firbase functions code.

I simply use ndb yarn serve.

Also, I've only tested in on HTTPS functions so far.

GorvGoyl · 2019-11-29T21:23:42Z

@goleary hey, i followed the steps but that just opens the ndb window. debugging session doesn't start. are there any additional steps to follow?

samtstern · 2019-12-12T20:32:56Z

This has been implemented and will be included in the next release.

vongohren · 2019-12-12T21:05:52Z

@samtstern are there any documentation on this?

samtstern · 2019-12-12T21:16:28Z

Working on that! We should have the docs ready before the next release so it will be clear how to use it.

…

On Thu, Dec 12, 2019, 1:05 PM Snorre Lothar von Gohren Edwin < ***@***.***> wrote: @samtstern <https://github.com/samtstern> are there any documentation on this? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1360?email_source=notifications&email_token=ACATB2QTBE33DXGTHWZ4N6LQYKRTFA5CNFSM4HSDFLEKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEGYBAWQ#issuecomment-565186650>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACATB2V7SNZ4E3MFZ5VRYDLQYKRTFANCNFSM4HSDFLEA> .

vongohren · 2019-12-12T21:29:36Z

@samtstern coolio, great work!

goleary · 2019-12-12T21:56:10Z

@JerryGoyal sorry for the delayed response. You're right, you might as well just use ndb in the folder and then start the debugging session by hitting play on one of the scripts on the bottom left:

GorvGoyl · 2019-12-13T21:52:56Z

@samtstern I upgraded to 7.10.0, updated the launch.json to

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "attach",
      "name": "Attach",
      "port": 9229,
      "restart": true,
      "skipFiles": [
        "<node_internals>/**"
      ]
    }
  ]
}

and tried attaching debugger to firebase emulators:start and also firebase functions:shell but issue remains the same:

Am I missing something here?

samtstern · 2019-12-13T21:53:56Z

@JerryGoyal 7.10.0 is the current release. This will be included in the next release, so 7.11.0 is the likely version number.

fabianotavallini · 2019-12-19T15:59:12Z

Version 7.11.0 is now released and introduces breakpoint debugging with the command:

firebase emulators:start --inspect-functions

Then you can attach the debugger to port 9229 (default)

johngtb · 2020-01-08T11:22:44Z

Version 7.11.0 is now released and introduces breakpoint debugging with the command:
firebase emulators:start --inspect-functions
Then you can attach the debugger to port 9229 (default)

Perfect!
Is there a way around the 60s timeout while debugging with --inspect-functions?

Error: Function timed out.
at Timeout._onTimeout (/home/john/.nvm/versions/node/v12.14.0/lib/node_modules/firebase-tools/lib/emulator/functionsEmulatorRuntime.js:670:23)
at listOnTimeout (internal/timers.js:531:17)
at processTimers (internal/timers.js:475:7)

samtstern · 2020-01-08T17:29:17Z

@johngboutros that's a good feature request and I could see a few ways of achieving it:

a) Disable timeouts entirely in debug mode
b) Disable the timeout counter while a breakpoint is active
c) Other??

Would you mind filing a new issue to discuss?

otri · 2020-01-14T08:50:02Z

A bit of documentation about this would be really helpful on the Firebase site tutorials.
Trying to run with $ firebase serve did not run my npm script 'serve'

Instead I needed to go into my functions folder, and run npm directly with:
$ npm run-script serve

My functions/package.json script for serve looks like this now:
"serve": "tsc -w | firebase emulators:start --inspect-functions",
This allows watching for TypeScript changes, and starting up emulation with debugging.
This is super helpful when actively developing code on your local machine! Life is so much better now.

samtstern · 2020-01-14T17:01:19Z

@otri firebase serve does not run your npm serve script, it's a command in the CLI that starts up a local Hosting server.

A common point of confusion (which I agree needs better docs) is the overlap between serve and emulators:start. We intend for emulators:start to replace serve completely so for now your approach looks good.

avaines · 2020-03-25T09:29:22Z

After a good few hours of faffing about, I found this thread and have confirmed what @otri has described above.

I have added a 'debug' entry to my functions/packages.json as i am not using TypeScript mine looks like this:
"scripts": { "serve": "firebase serve --only functions", "debug": "firebase emulators:start --inspect-functions", },

VSCode's launch.json now looks like this;
{ "version": "0.2.0", "configurations": [ { "type": "node", "request": "attach", "name": "Attach", "port": 6000 } ] }

If I launch my application from the terminal in VSCode itself the debugger attaches automatically.
cd functions & npm run debug

Whilst this does not fix the issue using firebase serve it is a suitable work around (for some of us at least) for local development until this is resolved properly.

samtstern · 2020-03-25T12:14:19Z

@n3rden firebase serve will not be changed to have this capability. You can serve both your hosting and functions code using emulators:start and that is the preferred method going forward.

avaines · 2020-03-25T12:31:16Z

Going forward I appreciate, but at present that method doesn't seem to work with breakpoints.

otri · 2020-03-25T12:31:52Z

Hi Sam, I think it would be really good to look at this as a developer stumbling blocker and doing a number of things to improve the situation. Firebase team could do this: 1) Provide a tip right at execution or via command help info for the necessary steps to enable debugging. 2) update the help documentation online about how to rig up your vscode launch.json for attach debugging. 3) link the command line help to online help so developer can jump to it. Emulator usage is invariably linked to the need to debug. Why leave this friction in place? - Aaron

On Wed, Mar 25, 2020 at 21:14 Sam Stern ***@***.***> wrote: @n3rden <https://github.com/n3rden> firebase serve will not be changed to have this capability. You can serve both your hosting and functions code using emulators:start and that is the preferred method going forward. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1360 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAHHYAQB3KDA7KLAFLLOFA3RJHYSVANCNFSM4HSDFLEA> .

--

…

_______________________ Aaron Hilton Steampunk Digital mobile: +81 80 3947 6874 <+818039476874> skype: otristudios facetime: [email protected] Monocle 3D Portrait <https://goo.gl/w0JV66>

samtstern · 2020-03-25T12:36:58Z

@n3rden if your breakpoints aren't working can you file a new issue? We will dig into it.
@otri I agree, those steps are needed to make this a better experience. Thank you for the tips.

quantuminformation · 2020-05-11T21:48:58Z

At the risk of sounding stupid if functions are running on

✔ functions: functions emulator started at http://localhost:5002

Then my local endpoint is just this change?

samtstern · 2020-05-11T22:18:45Z

@quantuminformation a local function would be at a URL like this:
http://localhost:5002/PROJECTID/us-central1/FUNCTIONNAME

But a deployed function would be here:
https://us-central1-PROJECTID.cloudfunctions.net/FUNCTIONNAME

In the future please file new issues if you have new questions.

quantuminformation · 2020-05-12T07:45:04Z

Sure, thanks for clearing this up

lborgman · 2020-05-19T12:00:42Z

When trying to use "firebase emulators:start" it did not work. I notice two things:

The docs at https://firebase.google.com/docs/rules/emulator-setup says I should use the latest Node.js. Is that correct?
The docs point me to https://www.oracle.com/java/technologies/javase-downloads.html while the CLI said I should go to https://openjdk.java.net/install/. Which one is correct? (The downloaded zip files for Win64 are obviously different with different sha256.)

samtstern · 2020-05-19T14:38:51Z

@lborgman

You should use Node.js 10, I will update the docs.
Any version of Java will work, but thank you for showing that discrepancy,

samtstern · 2020-05-19T14:39:19Z

I am locking this issue as it references a fixed bug and future developers should file new issues

thechenky closed this as completed Jun 2, 2019

samtstern reopened this Jun 3, 2019

samtstern added emulator-suite emulators: functions labels Jun 3, 2019

samtstern assigned abeisgoat Jun 3, 2019

abeisgoat added the Needs: Author Feedback Issues awaiting author feedback label Jun 3, 2019

google-oss-bot added Needs: Attention and removed Needs: Author Feedback Issues awaiting author feedback labels Jun 3, 2019

bkendall removed the Needs: Attention label Jun 4, 2019

abeisgoat mentioned this issue Jun 10, 2019

code reloads on every request in 6.10.0 #1353

Closed

samtstern mentioned this issue Jul 24, 2019

[EASY!] firebase emulator:start (in debug mode) #1541

Closed

samtstern mentioned this issue Sep 23, 2019

How to locally debug the a project #1667

Closed

grant mentioned this issue Oct 4, 2019

How to combine functions and firestore? GoogleCloudPlatform/functions-framework-nodejs#101

Closed

samtstern mentioned this issue Nov 14, 2019

Functions breakpoint debugging #1798

Merged

5 tasks

samtstern closed this as completed in #1798 Dec 12, 2019

samtstern mentioned this issue Jan 21, 2020

Change timeout behavior when Functions emulator running in debug mode #1931

Closed

GorvGoyl mentioned this issue Feb 21, 2020

[Feature Request] Breakpoint debugging for trigger functions #1990

Closed

snyk-bot mentioned this issue Mar 15, 2020

[Snyk] Upgrade firebase-tools from 7.2.2 to 7.13.1 mikaelvesavuori/serverless-graphql-api-gcp#5

Merged

firebase locked as resolved and limited conversation to collaborators May 19, 2020

Can't debug with firebase tools 6.10.0 in vs code due to unverified breakpoints #1360

Can't debug with firebase tools 6.10.0 in vs code due to unverified breakpoints #1360

Comments

ke-nzo commented Jun 2, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

[REQUIRED] Environment info

[REQUIRED] Test case

[REQUIRED] Steps to reproduce

[REQUIRED] Expected behavior

[REQUIRED] Actual behavior

google-oss-bot commented Jun 2, 2019

Uh oh!

thechenky commented Jun 2, 2019

Uh oh!

ke-nzo commented Jun 3, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

samtstern commented Jun 3, 2019

Uh oh!

abeisgoat commented Jun 3, 2019

Uh oh!

ke-nzo commented Jun 3, 2019

Uh oh!

abeisgoat commented Jun 3, 2019

Uh oh!

abeisgoat commented Jun 7, 2019

Uh oh!

sultanmyrza commented Jul 25, 2019

Uh oh!

vongohren commented Sep 21, 2019

Uh oh!

goleary commented Nov 20, 2019

Uh oh!

GorvGoyl commented Nov 29, 2019

Uh oh!

samtstern commented Dec 12, 2019

Uh oh!

vongohren commented Dec 12, 2019

Uh oh!

samtstern commented Dec 12, 2019 via email

Uh oh!

vongohren commented Dec 12, 2019

Uh oh!

goleary commented Dec 12, 2019

Uh oh!

GorvGoyl commented Dec 13, 2019

Uh oh!

samtstern commented Dec 13, 2019

Uh oh!

fabianotavallini commented Dec 19, 2019

Uh oh!

johngtb commented Jan 8, 2020

Uh oh!

samtstern commented Jan 8, 2020

Uh oh!

otri commented Jan 14, 2020

Uh oh!

samtstern commented Jan 14, 2020

Uh oh!

avaines commented Mar 25, 2020

Uh oh!

samtstern commented Mar 25, 2020

Uh oh!

avaines commented Mar 25, 2020

Uh oh!

otri commented Mar 25, 2020 via email

Uh oh!

samtstern commented Mar 25, 2020

Uh oh!

quantuminformation commented May 11, 2020

Uh oh!

samtstern commented May 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

quantuminformation commented May 12, 2020

Uh oh!

lborgman commented May 19, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

samtstern commented May 19, 2020

ke-nzo commented Jun 2, 2019 •

edited

Loading

ke-nzo commented Jun 3, 2019 •

edited

Loading

samtstern commented May 11, 2020 •

edited

Loading

lborgman commented May 19, 2020 •

edited

Loading