voxel51/fiftyone

[FR] Add helpful error message when using the App in a remote notebook without appropriate port forwarding

Open

#1,128 opened on Jul 16, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (400 forks)batch import
appenhancementgood first issuenotebook

Repository metrics

Stars
 (4,021 stars)
PR merge metrics
 (Avg merge 3d 11h) (161 merged PRs in 30d)

Description

When using the FiftyOne App in a remote Jupyter notebook, you need to forward the port used by the App (say YYYY):

# On local machine
ssh -N -L 5151:localhost:YYYY [<username>@]<hostname>

so that when you launch the App in a notebook cell:

# Launch the App in a notebook cell
session = fo.launch_app(dataset, port=YYYY)

you will see the App as expected.

However, if you don't forward the port, you'll see this when launching the App:

It would be helpful to the user if we detected this case and printed a helpful error message instructing the user how to forward the port and pointing them to documentation on the subject.

Contributor guide

Research direction
Implement detection of missing port forwarding when launching the App in a remote Jupyter notebook, and display a helpful error message with port forwarding instructions.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80