Underlying plumbing/infrastructure for Porter CLI/RestApp by derekpierre · Pull Request #2713 · nucypher/nucypher

derekpierre · 2021-05-26T14:24:05Z

Type of PR:

Bugfix
Feature
Documentation
Other

Required reviews:

1
2
3

What this does:
This refactoring will facilitate a non-character learner like "Porter" to utilize the existing schema/controllers infrastructure for REST-like endpoints.

A lot of prior work was done for CLI/JSON/Web controllers and verification of inputs via schema definitions for the "character control" that can be reused for Porter. However, Porter isn't a character, so some of the plumbing needs to be modified to allow for the possibility of a non-character utilizing the same infrastructure. I think of it as just a base control for that maps to an interface and the underlying implementation of that interface may be a character (eg. Alice, Bob etc.) or not (eg. Porter).

Chatted with @vepkenez and @KPrasch about it yesterday.

Once that refactoring is done, Porter can benefit from the ease of utilizing a CLIConroller and a WebController with built-in function mapping and parameter validation.

Closes #2702 .
Closes #2668.

derekpierre · 2021-05-27T20:22:23Z

There is now a simple CLI available and a WebController. Of course, any actual Porter functionality on behalf of Alice/Bob is only stubbed out and not implemented. However, the control infrastructure allows for implicit CLI options, and rest endpoints to be appropriately mapped.

$ nucypher porter --help
Usage: nucypher porter [OPTIONS] COMMAND [ARGS]...

  Porter management commands. Porter is the conduit between web apps and the
  nucypher network, that performs actions on behalf of Alice and Bob.

Options:
  --help  Show this message and exit.

Commands:
  exec-work-order       Execute a PRE work order on behalf of Bob.
  get-treasure-map      Retrieve a treasure map on behalf of Bob.
  get-ursulas           Sample Ursulas on behalf of Alice.
  publish-treasure-map  Publish a treasure map on behalf of Alice.
  revoke                Off-chain revoke of a policy on behalf of Alice.
  run                   Start Porter's Web controller.

And a very simple HTTP Web controller that can be run:

$ nucypher porter run --provider https://mainnet.infura.io/v3/<app_id> --network mainnet


 ______
(_____ \           _
 _____) )__   ____| |_  ____  ____
|  ____/ _ \ / ___)  _)/ _  )/ ___)
| |   | |_| | |   | |_( (/ /| |
|_|    \___/|_|    \___)____)_|

the conduit between web apps and the nucypher network

Network: Mainnet
Provider: https://mainnet.infura.io/v3/<app_id>
Running Porter Web Controller at http://localhost:9155

(In parallel)

$ curl http://localhost:9155/get_ursulas
{'quantity': ['Missing data for required field.'], 'duration_periods': ['Missing data for required field.']}

nucypher/control/controllers.py

derekpierre · 2021-05-28T20:22:29Z

Filed follow-up issue #2714 for reviewing the inconsistencies with some of the original character controls fields.

nucypher/characters/banners.py

nucypher/blockchain/eth/actors.py

nucypher/characters/base.py

nucypher/cli/main.py

nucypher/control/specifications/fields/base.py

nucypher/utilities/porter/control/controllers.py

nucypher/utilities/porter/porter.py

KPrasch · 2021-05-31T19:14:52Z

nucypher/utilities/porter/porter.py

+from nucypher.utilities.porter.control.interfaces import PorterInterface
+
+
+class Porter(Learner):


Naming things: Are we settled on "Porter"?

Nope - can be changed. That's just what we've been calling it up until now. Even if we like the name, this learner class does not need to be called Porter.

KPrasch · 2021-05-31T19:16:18Z

nucypher/utilities/porter/porter.py

+        self.interface = self._interface_class(porter=self)
+        self.controller = NO_CONTROL_PROTOCOL
+        if controller:
+            # TODO need to understand this better - only made it analogous to what was done for characters


Is there any scernerio where you'd want to programmatically use a Porter instance without the CLI?

This was the thing I wasn't sure about. Characters eg. Alice, Bob seem to also use this same code block when is_me is True, and it was unclear to me why they would do that, when they may be used without the CLI.

nucypher/utilities/porter/porter.py

…racter control" into a general "base control" from which "character control" can sub-class.

…rafted a very simple run command for the Porter CLI.

… were incorrect or over-engineered.

derekpierre added this to the Porter v1 (MVP) milestone May 26, 2021

derekpierre added a commit to derekpierre/nucypher that referenced this pull request May 26, 2021

Add newsfragment for nucypher#2713.

22e5073

derekpierre changed the title ~~[WIP] Abstract what is now "Character Control" specific into a general "base control" from which "character control" can sub-class~~ [WIP] Underlying plumbing/infrastructure for Porter CLI/RestApp May 26, 2021

derekpierre requested review from KPrasch and vepkenez May 27, 2021 16:17

derekpierre changed the base branch from main to porter May 27, 2021 16:20

derekpierre added a commit to derekpierre/nucypher that referenced this pull request May 27, 2021

Add newsfragment for nucypher#2713.

d02c998

derekpierre force-pushed the control-refactoring branch 2 times, most recently from 4743688 to 6ccf22c Compare May 27, 2021 16:30

derekpierre requested a review from piotr-roslaniec May 27, 2021 16:40

derekpierre self-assigned this May 27, 2021

derekpierre requested a review from cygnusv May 27, 2021 20:21

derekpierre changed the title ~~[WIP] Underlying plumbing/infrastructure for Porter CLI/RestApp~~ Underlying plumbing/infrastructure for Porter CLI/RestApp May 27, 2021

derekpierre marked this pull request as ready for review May 27, 2021 20:23

piotr-roslaniec reviewed May 28, 2021

View reviewed changes

nucypher/control/controllers.py Outdated Show resolved Hide resolved

piotr-roslaniec reviewed May 28, 2021

View reviewed changes

nucypher/control/controllers.py Show resolved Hide resolved

derekpierre added CLI This effects the nucypher CLI Web Webpages labels May 28, 2021

derekpierre mentioned this pull request May 28, 2021

Review some of the existing character control fields for serialize/deserlization consistency and validation #2714

Closed

derekpierre linked an issue May 28, 2021 that may be closed by this pull request

REST App/CLI built around Porter "Learner" #2702

Closed

derekpierre mentioned this pull request May 28, 2021

Basic Porter "Learner" #2668

Closed

derekpierre force-pushed the control-refactoring branch from 983354e to 17e3088 Compare May 31, 2021 13:19

KPrasch reviewed May 31, 2021

View reviewed changes

derekpierre added a commit to derekpierre/nucypher that referenced this pull request May 31, 2021

Respond to RFCs for nucypher#2713.

72e7646

derekpierre added a commit to derekpierre/nucypher that referenced this pull request Jun 1, 2021

Respond to RFCs for nucypher#2713.

4cafbf4

derekpierre force-pushed the control-refactoring branch from 72e7646 to 4cafbf4 Compare June 1, 2021 13:23

derekpierre mentioned this pull request Jun 2, 2021

POC Porter implementation for /get_treasure_map, /publish_treasure_map, and /get_ursulas (unaffected by TMapConKFrags work) #2717

Merged

7 tasks

derekpierre requested a review from jMyles June 4, 2021 19:38

derekpierre force-pushed the porter branch from 7a15dcb to 98319d1 Compare June 7, 2021 14:44

derekpierre added 11 commits June 7, 2021 10:48

Initial refactoring of "character control"; abstract what is now "cha…

10b213a

…racter control" into a general "base control" from which "character control" can sub-class.

Initial dump of the idea for Porter Schema definition.

3bb332b

Ensure that porter schema input parameters have 'load_only' set to True.

2722404

CLI plumbing for Porter based on Porter schema.

69ee4a6

Web Controller/Rest App plumbing for Porter based on Porter Schema. D…

c4dd29f

…rafted a very simple run command for the Porter CLI.

Fix Porter CLI logging issues and add rpc controller.

c878257

Simple code cleanup regarding field specifications - some definitions…

1f28c65

… were incorrect or over-engineered.

Initial unit tests for fields.

95f8762

Add tests for Porter Schema definitions.

cae52b8

Clarify what next steps are needed for actual implementation.

44a8f8f

Respond to RFCs for nucypher#2713.

76a2420

derekpierre force-pushed the control-refactoring branch from 4cafbf4 to 76a2420 Compare June 7, 2021 14:49

KPrasch approved these changes Jun 7, 2021

View reviewed changes

piotr-roslaniec approved these changes Jun 8, 2021

View reviewed changes

vepkenez approved these changes Jun 9, 2021

View reviewed changes

derekpierre merged commit da11222 into nucypher:porter Jun 9, 2021

This was referenced Jun 9, 2021

[EPIC] Porter MVP - "Infura for NuCypher" #2664

Merged

REST App/CLI built around Porter "Learner" #2702

Closed

derekpierre added a commit to derekpierre/nucypher that referenced this pull request Jul 7, 2021

Respond to RFCs for nucypher#2713.

39d397e

derekpierre added a commit to derekpierre/nucypher that referenced this pull request Jul 12, 2021

Respond to RFCs for nucypher#2713.

a0dbd31

derekpierre added a commit that referenced this pull request Jul 12, 2021

Respond to RFCs for #2713.

0be562a

derekpierre added a commit that referenced this pull request Jul 26, 2021

Respond to RFCs for #2713.

babb78f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Underlying plumbing/infrastructure for Porter CLI/RestApp#2713

Underlying plumbing/infrastructure for Porter CLI/RestApp#2713
derekpierre merged 11 commits intonucypher:porterfrom
derekpierre:control-refactoring

derekpierre commented May 26, 2021 •

edited

Loading

Uh oh!

derekpierre commented May 27, 2021

Uh oh!

Uh oh!

Uh oh!

derekpierre commented May 28, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

KPrasch May 31, 2021

Uh oh!

derekpierre May 31, 2021

Uh oh!

KPrasch May 31, 2021

Uh oh!

derekpierre May 31, 2021

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		from nucypher.utilities.porter.control.interfaces import PorterInterface


		class Porter(Learner):

Conversation

derekpierre commented May 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

derekpierre commented May 27, 2021

Uh oh!

Uh oh!

Uh oh!

derekpierre commented May 28, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

KPrasch May 31, 2021

Choose a reason for hiding this comment

Uh oh!

derekpierre May 31, 2021

Choose a reason for hiding this comment

Uh oh!

KPrasch May 31, 2021

Choose a reason for hiding this comment

Uh oh!

derekpierre May 31, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

derekpierre commented May 26, 2021 •

edited

Loading