#1735 closed defect (fixed)

the banner on the Welcome page saying that a helper is not configured should not be red

Reported by: davidsarah Owned by: zooko
Priority: normal Milestone: 1.10.0
Component: code-frontend-web Version: 1.9.1
Keywords: welcome wui aesthetics usability easy reviewed Cc:
Launchpad Bug:

Description

On 13/05/12 08:55, Michael Rogers wrote:

  1. The client's welcome page has scary red warning about not being

connected to a helper. I wasn't sure whether I needed a helper (apparently not?).

If a helper is not configured, the banner should not be red. (It should be white or yellow or something like that.)

Attachments (2)

1735-helper_banner_higlight.diff (1.9 KB) - added by kick at 2012-08-31T09:20:40Z.
1735-helper_banner_highlight_v2.diff (4.9 KB) - added by kick1 at 2012-09-07T04:39:37Z.

Download all attachments as: .zip

Change History (13)

comment:1 Changed at 2012-05-14T23:58:10Z by warner

yeah, I think:

  • helper.furl not configured: white, or something neutral
  • helper.furl configured and connected: pale green
  • helper.furl configured and not connected: red

I wouldn't want to imply that Helper-less clients are somehow inferior, but at the same time if you've configured a Helper and it's not connected, then things are mildly wrong (upload performance will be lower than you'd expect).

OTOH, an introducer that isn't connected is more serious.. that should be properly red.

comment:2 Changed at 2012-08-31T09:24:00Z by kick

  • Owner set to kick
  • Status changed from new to assigned

The patch submitted highlights the helper banner as green if the helper is disabled. A note is left in the banner saying faster uploads can be achieved. Change the wording and styling as necessary...

comment:3 Changed at 2012-08-31T18:02:41Z by zooko

  • Keywords review-needed added

comment:4 Changed at 2012-09-04T19:27:57Z by warner

  • Keywords review-needed removed

Kick: looks good! Some ideas we had:

  • could you change the "not-configured" color to plain white (to match the background), instead of light green? We figured it'd be good to be as neutral as possible for something which isn't configured.
  • I'd use "unconfigured" instead of "disabled", in general (since "disabled" kind of implies that using a Helper is the normal state, whereas actually Helpers are somewhat unusual).
  • I'd recommend leaving out the "no, enable for quicker uploads" line: the actual benefit of the helper will depend upon having a helper that's closer to the servers than you are, and on using encoding parameters that help (in some cases the helper will be slower than a direct upload). Simply saying "unconfigured" would be enough.
  • the indentation in data_connected_to_helper_description() looks wrong.. maybe it's using tabs? All python code should use four-space indents.
  • we should add a test for this. The test should local the Welcome page three times: once with no helper configured, a second time with the helper furl configured but no connection, and a third time with the helper connected. test_web.py is the place to add it, in the existing Web.test_welcome case (around line 526). The test will need a little more support in FakeUploader (line 102), to return e.g. self.helper_furl and self.helper_connected instead of always returning (None, False). Then the test case can reach into self.s.uploader and set helper_furl/helper_connected between the different cases. You'll need to follow the pattern in test_welcome(): self.GET() returns a Deferred, so you'll add a helper function (that scans the HTML output for "Connected to helper?: unconfigured", etc) through a d.addCallback.

Grab any of us (warner, zooko, davidsarah) on IRC if you need a hand with the test.

thanks!

-Brian

comment:5 Changed at 2012-09-07T04:42:41Z by kick1

Added new attachment with suggestions. Having the background white with no border looks a bit off. Maybe spacing can help?

comment:6 Changed at 2012-12-20T17:59:17Z by warner

  • Owner changed from kick to warner
  • Status changed from assigned to new

I'll try to land this over the coming weekend.

comment:7 Changed at 2012-12-29T02:43:01Z by davidsarah

  • Owner changed from warner to davidsarah
  • Status changed from new to assigned

Taking this over.

comment:8 follow-up: Changed at 2012-12-29T03:45:01Z by davidsarah

I added a grey (#CCC) 1-pixel border around the "not configured" box, fixed the trailing whitespace, and made some minor coding style cleanups to the tests.

The patch is not working when I smoke-test it, though; it's still displaying "no" for my gateway that doesn't have a helper configured, rather than "not configured". Investigating.

comment:9 in reply to: ↑ 8 Changed at 2012-12-29T04:25:30Z by davidsarah

  • Keywords review-needed added
  • Owner changed from davidsarah to warner
  • Status changed from assigned to new

Replying to davidsarah:

The patch is not working when I smoke-test it, though; it's still displaying "no" for my gateway that doesn't have a helper configured, rather than "not configured". Investigating.

The problem was that I had "helper.furl =" rather than "helper.furl = None", or no "helper.furl" line.

I decided to normalize the furl to None in client.py, and add a test that the normalization is done correctly.

Pull request at https://github.com/tahoe-lafs/tahoe-lafs/pull/27, review needed.

comment:10 Changed at 2012-12-29T21:30:20Z by davidsarah

  • Owner changed from warner to zooko

Committed in bf0e7ce3cc4a39a7. Leaving open for review.

comment:11 Changed at 2013-02-01T22:49:04Z by zooko

  • Keywords reviewed added; review-needed removed
  • Resolution set to fixed
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.