help: choose pastebin service for .help output #1451

uint · 2019-01-15T19:53:21Z

Description

I've created a new config section help with the output setting. output can currently be set to:

"ptpb"
"0x0"
"hastebin"
"termbin"

This resolves #1416.

Example

19:42 <uint> .set help.output termbin
19:42 <uint> .help
19:43 <uint-bot> Hang on, I'm creating a list.
19:43 <uint-bot> I've posted a list of my commands at https://termbin.com/3tyx2 - You can see more
                 info about any of these commands by doing .help <command> (e.g. .help time)

Potential problems

It seems that if I use .help, the bot will cache the url. If I then change the output option to something else, the bot won't let me use the new service since it still has the old link cached. This could lead to problems if the old link is erroneous and the user can't get a new one until they restart the bot.

@dgw Is it possible to make it so that changing the config option also triggers the cached data to be cleared? I think that would be the simplest solution.

Next steps?

We probably really should add an option for the bot to simply "say" the command list, either in the channel or a private message. Should I work on that too?

Version

19:51 <uint> .version
19:51 <uint-bot> uint: Sopel v. 6.5.3

HumorBaby · 2019-01-16T13:39:07Z

In regards to the caching issue: Sopel won't re-read a config file after editing manually (that I know of). The main way to change the config on the fly is to use things like .set and .save from the admin.py module. This will update the configuration object used by the bot and allow you to save said changes to the config. Ideally this is how .help paste provides will be changed by the user also.

One solution could be to store the current pastebin provider right next to the cached URL, and check if the current config.help.output matches the cached value you have stored before sending. This alternative would make it so the config load/update logic would not need to be changed, as this could be implemented purely in help.py.

uint · 2019-01-16T13:46:00Z

@HumorBaby What I could do is change help.py so that it caches both the url and the string denoting the pastebin provider. Then I can very easily make sure the cache is only used if the cached provider matches the one currently configured. Does that sound sane?

HumorBaby · 2019-01-16T13:57:38Z

@uint, yep 😄

uint · 2019-01-16T16:54:08Z

On rereading your post, that's exactly what you suggested ;) There goes my reading comprehension. But yeah. I'll add a commit soon.

kwaaak · 2019-01-24T05:39:35Z

hastebin.com had an interruption a few days ago, posting was returning a 503 error.

I wonder if it would be a good idea to - if there is no service configured - randomly pick a service, and try another one if there is an error.

sopel/modules/help.py

dgw · 2019-03-09T07:40:11Z

After 6.6.4 is released and its changes merged to master, this should be rebased (it probably will gain a merge conflict or three because of #1495).

Also, ptpb is shut down (semi-?)permanently (ptpb/pb#246), so it would be good to remove that option. Maybe replace it with clbin?

dgw · 2019-03-27T20:14:27Z

@uint *poke*

dgw · 2019-04-19T00:18:12Z

Rebased and "squashed" the whitespace-fix commits (not actually squashed, since both batches of fixed applied to multiple commits each).

Next will be removing ptpb and adding… something else. Like clbin.

(Edited/rebased to switch default from ptpb -> clbin, and whitespace fixed, by dgw) Co-Authored-By: dgw <dgw@technobabbl.es>

dgw · 2019-04-19T00:30:04Z

And ptpb->clbin default change: done

(Rebased, default changed from ptpb->clbin, 0x0 switched to HTTPS, and whitespace fixed by dgw) Co-Authored-By: dgw <dgw@technobabbl.es>

(Rebased and whitespace fixed by dgw) Co-Authored-By: dgw <dgw@technobabbl.es>

HumorBaby

One (optional) change requested for consistency and two (I would like to say required, at least in one form or another) changes requested for proper error handling of the low-level socket for termbin.

The overarching theme of this review is.... 🎰 error handling!

sopel/modules/help.py

HumorBaby

Imagine this was a part of the previous review... 🍄

sopel/modules/help.py

All `requests.post()` calls moved to a wrapper that catches all the appropriate exception types and re-raises them as `PostingException` to simplify the error handling across callers. Termbin socket operations wrapped in a try/except, which will re-raise any error as a `PostingException` just like any other supported service.

Tomasz Kurcz definitely contributed enough code to be included here. Also took the liberty of including myself, since I'm rewriting a fair chunk of the new pastebin code.

Sometimes it depends on whether you called the API over HTTP or HTTPS. Sometimes the site just wants to save on HTTPS overhead by returning a URL with `http://`, hoping nobody will notice/care and correct it. We always call over HTTPS, but we'll make sure any valid response is acceptable (with or without the `s`) and enforce HTTPS before output.

`_pastebin_providers` -> `PASTEBIN_PROVIDERS` `s` (for socket object) -> `sock`

dgw · 2019-04-19T07:30:20Z

@HumorBaby Did a pretty big overhaul of error handling, and a few other little things while I was at it. 🚀

Exirel

Just some nitpicks. But I approve otherwise.

sopel/modules/help.py

This is just "by convention" stuff, nothing substantive.

HumorBaby

🏆

Misc. notes: At first, I was worried that @dgw improperly capitalized Hastebin 😱, but alas, since it seems to be a descendant of Haste, I have now come around to accepting the current capitalization.

uint · 2019-04-19T12:08:46Z

Hey. Sorry for not having been responsive! Pretty busy and I... probably should configure e-mail notifications. Ahem.

Exirel · 2019-04-19T12:18:23Z

@uint no worry! Our dear maintainer @dgw took it from where you left, co-authored the first commits and added some more. Also thank you for these first commits! 👍

dgw · 2019-04-19T20:21:27Z

@uint You got us 90% of the way there! Most of what I did was just sanding off rough edges. 🙌 Without your initial set of commits, this feature would still be "Patches Welcome", but it's done!

As for non-pastebin help output, we are tracking that in #1212. I think @RustyBower is working on something for that, unless he changed his mind. Feel free to join us in the #sopel IRC channel on freenode if you want to avoid duplicating effort on any future contributions. And thank you again for this PR!

Exirel reviewed Jan 24, 2019

View reviewed changes

sopel/modules/help.py Outdated Show resolved Hide resolved

HumorBaby mentioned this pull request Jan 26, 2019

help: add config to hide server host from help listing #1459

Merged

HumorBaby reviewed Jan 26, 2019

View reviewed changes

sopel/modules/help.py Show resolved Hide resolved

dgw added the Feature label Jan 29, 2019

dgw added this to the 7.0.0 milestone Jan 29, 2019

dgw mentioned this pull request Mar 27, 2019

help: pastebin provider should be configurable #1416

Closed

help: add a config option to choose cmd list output

9f7d1c1

(Edited/rebased to switch default from ptpb -> clbin, and whitespace fixed, by dgw) Co-Authored-By: dgw <dgw@technobabbl.es>

dgw requested a review from a team April 19, 2019 00:36

Tomasz Kurcz and others added 4 commits April 18, 2019 19:40

help: add 0x0, hastebin, and termbin as help outputs

7781724

(Rebased, default changed from ptpb->clbin, 0x0 switched to HTTPS, and whitespace fixed by dgw) Co-Authored-By: dgw <dgw@technobabbl.es>

help: call pastebin handlers more explicitly, avoid using globals()

1e367a9

(Rebased, default changed from ptpb->clbin, 0x0 switched to HTTPS, and whitespace fixed by dgw) Co-Authored-By: dgw <dgw@technobabbl.es>

help: add pastebin provider choice to config wizard

2dd05e1

(Rebased and whitespace fixed by dgw) Co-Authored-By: dgw <dgw@technobabbl.es>

help: fix overzealous url caching

38e30e6

(Rebased and whitespace fixed by dgw) Co-Authored-By: dgw <dgw@technobabbl.es>

HumorBaby requested changes Apr 19, 2019

View reviewed changes

sopel/modules/help.py Outdated Show resolved Hide resolved

sopel/modules/help.py Outdated Show resolved Hide resolved

sopel/modules/help.py Outdated Show resolved Hide resolved

HumorBaby requested changes Apr 19, 2019

View reviewed changes

sopel/modules/help.py Outdated Show resolved Hide resolved

dgw added 5 commits April 19, 2019 01:27

help: remove unused bot arg to pastebin handlers

9be3283

help: Header update (import order & copyrights)

88dbd7d

Tomasz Kurcz definitely contributed enough code to be included here. Also took the liberty of including myself, since I'm rewriting a fair chunk of the new pastebin code.

help: Docstring add/update

b7154cc

help: variable/constant naming style

6e6a4c3

`_pastebin_providers` -> `PASTEBIN_PROVIDERS` `s` (for socket object) -> `sock`

Exirel approved these changes Apr 19, 2019

View reviewed changes

sopel/modules/help.py Outdated Show resolved Hide resolved

sopel/modules/help.py Show resolved Hide resolved

sopel/modules/help.py Outdated Show resolved Hide resolved

help: rearrange things a bit

6e26a05

This is just "by convention" stuff, nothing substantive.

HumorBaby approved these changes Apr 19, 2019

View reviewed changes

dgw merged commit 16eeefc into sopel-irc:master Apr 19, 2019

dgw mentioned this pull request Apr 21, 2019

currency: Moved to different API, support multiple target currencies, cache rates #1430

Merged

Exirel mentioned this pull request Sep 26, 2019

help: using a pastebin should be optional #1212

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

help: choose pastebin service for .help output #1451

help: choose pastebin service for .help output #1451

uint commented Jan 15, 2019 •

edited by dgw

Loading

HumorBaby commented Jan 16, 2019

uint commented Jan 16, 2019

HumorBaby commented Jan 16, 2019

uint commented Jan 16, 2019

kwaaak commented Jan 24, 2019

dgw commented Mar 9, 2019

dgw commented Mar 27, 2019

dgw commented Apr 19, 2019

dgw commented Apr 19, 2019

HumorBaby left a comment •

edited

Loading

HumorBaby left a comment

dgw commented Apr 19, 2019

Exirel left a comment

HumorBaby left a comment

uint commented Apr 19, 2019

Exirel commented Apr 19, 2019

dgw commented Apr 19, 2019

help: choose pastebin service for .help output #1451

help: choose pastebin service for .help output #1451

Conversation

uint commented Jan 15, 2019 • edited by dgw Loading

Description

Example

Potential problems

Next steps?

Version

HumorBaby commented Jan 16, 2019

uint commented Jan 16, 2019

HumorBaby commented Jan 16, 2019

uint commented Jan 16, 2019

kwaaak commented Jan 24, 2019

dgw commented Mar 9, 2019

dgw commented Mar 27, 2019

dgw commented Apr 19, 2019

dgw commented Apr 19, 2019

HumorBaby left a comment • edited Loading

Choose a reason for hiding this comment

HumorBaby left a comment

Choose a reason for hiding this comment

dgw commented Apr 19, 2019

Exirel left a comment

Choose a reason for hiding this comment

HumorBaby left a comment

Choose a reason for hiding this comment

🏆

uint commented Apr 19, 2019

Exirel commented Apr 19, 2019

dgw commented Apr 19, 2019

uint commented Jan 15, 2019 •

edited by dgw

Loading

HumorBaby left a comment •

edited

Loading