Major refactor of tutorial folder structure. #70

morrieinmaas · 2021-03-03T18:41:26Z

In accordance with isseue 61 description on GitHub

TODOs:

Fix all broken links within the notebooks
extend notebooks to cover mediation and multitenant
possibly introduce helper functions that cn be imported from extra
folder
!!! If medation and multitenant live in folder 1. the
docker-compose.yaml and manage script need to be adjusted to accomodate
for that setup. TBD what that looks like. More info
here

Description

Checklist

I have followed the Contribution Guidelines and Code of Conduct
I have commented my code following the OpenMined Styleguide
I have labeled this PR with the relevant Type labels
My changes are covered by tests

* In accordance with isseue 61 description on GitHub TODOs: * Fix all broken links within the notebooks * extend notebooks to cover mediation and multitenant * possibly introduce helper functions that cn be imported from extra folder * !!! If medation and multitenant live in folder 1. the docker-compose.yaml and manage script need to be adjusted to accomodate for that setup. TBD what that looks like. More info [here](https://github.com/hyperledger/aries-cloudagent-python/blob/main/Multitenancy.md#multi-tenant-admin-api)

* Created folder structure and numbering according to [issue 61](OpenMined/PyDentity#61) * Adjusted notebook crossreferences/links accordingly in all notebooks * Fixed some broken links to respective other notebooks in notebooks Fixed all links for 1. Learning Aries, ACA-py and the Basic Controller for * Alice's Notebooks * Checked all links manually Fixed all links for bob in 1 Basic concepts * All manually checked

Wallets

Basics to version-bump aca-py * Bumped aca-py version to 0.6 in Dockerfile * add auto-provision param to aries basic args * add auto-provision param to aries advanced args Adjust proof controller to reflect version 0.6 API of aca-py. * Added sending problem report function * Tidied up th ecode to reflect Python linting * Tidied up function definitions in order to reflect swagger docs order Bump version of aca-py for attachment protocol example * Change aca-py version for Docker image * add --auto-provision flag to aca-py start so it runs properly and a new wallet is created on startup Changes to plugin routes to work with v0.6.0 * Connection takes now a session instead of context * session is now a context property (context.session()) * context now comes from AdminRequestContext (new import) and is the request["context"] * Outbound_handler now directly takes the router from request and not app.request * ConnectionRecord has changed to ConnRecord (this takes the session) Add mediation controller * Added all async functions to cover mediation via API * minor fixes to proofs.py, fixed naming of parsed args Removed superfluous variable parsing in mediation.py Make changes to remove by topic method call without the dirty changes to the notebook like cell runs Add reference to mediation manual/README for usage Remove duplicate auto-provion flag from docker-compose.yml WIP Basic startup with multitenancy enabled * Pass args in dockercompose yaml * bump version of aca-py for ngrok bump aiohttp version to 3.7.2 WIP Basic notebook setup * create an basewallet agent * create an external agent * create notebook structure for each of the above ** Bob and Alice have separate folders because they each hold their own subwallets and can be considered different users on the same agent * Renaming varibales in manage and docker-compose.yml accordingly in order to reflect basewallet and ecternal agents

* create an basewallet agent * create an external agent * create notebook structure for each of the above ** Bob and Alice have separate folders because they each hold their own subwallets and can be considered different users on the same agent * Renaming varibales in manage and docker-compose.yml accordingly in order to reflect basewallet and ecternal agents Basics to version-bump aca-py * Bumped aca-py version to 0.6 in Dockerfile * add auto-provision param to aries basic args * add auto-provision param to aries advanced args Adjust proof controller to reflect version 0.6 API of aca-py. * Added sending problem report function * Tidied up th ecode to reflect Python linting * Tidied up function definitions in order to reflect swagger docs order Bump version of aca-py for attachment protocol example * Change aca-py version for Docker image * add --auto-provision flag to aca-py start so it runs properly and a new wallet is created on startup Changes to plugin routes to work with v0.6.0 * Connection takes now a session instead of context * session is now a context property (context.session()) * context now comes from AdminRequestContext (new import) and is the request["context"] * Outbound_handler now directly takes the router from request and not app.request * ConnectionRecord has changed to ConnRecord (this takes the session) Add mediation controller * Added all async functions to cover mediation via API * minor fixes to proofs.py, fixed naming of parsed args Removed superfluous variable parsing in mediation.py Make changes to remove by topic method call without the dirty changes to the notebook like cell runs Add reference to mediation manual/README for usage

* This will be handled by parsing startup args like described [here](https://github.com/hyperledger/aries-cloudagent-python/blob/b8f28dfe1b8b84f1fd5143bd5219c93b0913c3cc/aries_cloudagent/config/argparse.py)

wip-abramson · 2021-03-09T12:18:28Z

Sorry to be a pain but wondering about a slight refactor of tutorial structure for the first tutorial.

Basically Proofs tutorials wont work unless they have first issued themselves a credential. So perhaps it makes sense just to condense into the Credentials folder?

I also think Out of Band tutorial is an Advanced concept not a messaging one.

Like the tutorial names though!

* Extend the AriesController class to handle multitenancy * Update the API for multiitenancy to work properly ** Made request body optional where possible by providing a default * Create notebooks for Alice and Bob in order to ** Create two wallets on the same agent ** Cover all API endpoints for multi tenancy Signed-off-by: morrieinmaas <[email protected]>

morrieinmaas · 2021-03-09T19:22:11Z

@wip-abramson I'll refactor like that. Makes sense to me.

* Proofs tutorials now lives in Credentials folder * Out of band tutorial is now in Advanced Concepts folder

wip-abramson · 2021-03-12T11:14:52Z

configuration/aries-args-advanced.yaml

@@ -57,3 +57,4 @@ debug-connections: true
 debug-credentials: true
 debug-presentations: true
 enable-undelivered-queue: true
+open-mediation: true


We should specify this in the docker-compose instead

wip-abramson · 2021-03-12T11:15:47Z

libs/aries-basic-controller/aries_basic_controller/aries_controller.py

        issuer: bool = True,
        action_menu: bool = True,
        revocations: bool = True,
        api_key: str = None,
+        jwt_token: str = None,


can we call this subwallet_token or something like that

wip-abramson · 2021-03-12T11:17:37Z

libs/aries-basic-controller/aries_basic_controller/aries_controller.py

        if revocations:
            self.revocations = RevocationController(
                self.admin_url,
                self.client_session
            )

+
+    # def update_jwt_token(self, api_key: str):


I think we should have this.
something like set_subwallet_token

* Improve tutorial structure (WIP) * Extend AriesAgentController class to have a method that updates the JWT token

* Little more structure to Bob's tutorial Notebook. Still needs work * Check out the examples in the Websocket notebooks in the Bob folder ** This is a minimal-ish implementation of a Websocket server instead of http that can handle multiple client connections to solve the current webhook port-in-use problem. ** It already demonstrates running multiple clients on the same endpoint. Here 127.0.0.1:8090/ws. ** I reckon we can make this quite elegant by re-writing this further and using routes like /ws/{some-unique-wallet-id}/the-webhook-handle to send specific webhooks only to the actual recepient. ** For the previous point could even use authentication with that (not sure that's required actually because the agent should already be only able to connect when having the right credential?!) TODO: investigate this point.

instantiated twice. * Rewrite header assignment logic * Minor changes in notebooks

* Fix mediation API request_mediation to not require passing an empty object * Tidy up notebooks part 1 and 2 * Checked functionality of notebooks * Remove superfluous notebooks TODO: Finish part 3 of the tutorial notebooks

* Still need to accept credential

* Finished up notebooks * Changed startup logic to accomodate multitenent use and mediation ** This means passing a different env yaml file by setting a flag in manage

* manually checked

controller

morrieinmaas · 2021-03-19T00:33:26Z

@wip-abramson @lohanspies Please have a look. I'm happy for any feedback. Lesson learned, pulled too much into one task. that got a bit out of hand volume-wise.

lohanspies · 2021-03-19T15:33:46Z

at got a bit out of hand volume-wise.

Agree. Let us keep it focussed on small achievable chunks.

wip-abramson · 2021-03-19T18:55:59Z

configuration/aries-args-multitenant.yaml

+debug-credentials: true
+debug-presentations: true
+enable-undelivered-queue: true
+open-mediation: true


We should move this out of here

wip-abramson

All looks good to me, good work

morrieinmaas added 6 commits March 3, 2021 19:33

Renamed folder and fixed all links for 2. Public Ledgers and Mobile

5c05e34

Wallets

Remove multitenant args file

c27c398

* This will be handled by parsing startup args like described [here](https://github.com/hyperledger/aries-cloudagent-python/blob/b8f28dfe1b8b84f1fd5143bd5219c93b0913c3cc/aries_cloudagent/config/argparse.py)

morrieinmaas force-pushed the issue_61 branch from 10df19d to c27c398 Compare March 8, 2021 20:13

Merge branch 'master' into issue_61

0c48e72

morrieinmaas and others added 8 commits March 10, 2021 15:12

Address MR feedback to restructure tutorials folders

155b586

* Proofs tutorials now lives in Credentials folder * Out of band tutorial is now in Advanced Concepts folder

WIP trying to establish mediation with Alice and Bob on the same agent

e108029

fix jwt_token

e0f4eb5

clean up jtw debug prints

51337de

minor fixes in mediation.py

a47d533

delete stale notebook

85bd135

rename and updated notebooks

d5579e8

added reuse address and port

aa3bd7a

wip-abramson reviewed Mar 12, 2021

View reviewed changes

morrieinmaas and others added 8 commits March 15, 2021 15:55

WIP updating multitenancy notebooks

5e5c05f

* Improve tutorial structure (WIP) * Extend AriesAgentController class to have a method that updates the JWT token

add mediator agent

23713fb

update tutorial

3e52ab5

Fixing bug in aries controller ClientSession so it does not get

68a50a6

instantiated twice. * Rewrite header assignment logic * Minor changes in notebooks

Properly working tutorials Part 1 and 2 for mediation

6e6691f

* Fix mediation API request_mediation to not require passing an empty object * Tidy up notebooks part 1 and 2 * Checked functionality of notebooks * Remove superfluous notebooks TODO: Finish part 3 of the tutorial notebooks

WIP Almost finished with notebooks

e086d73

* Still need to accept credential

Multitenant tutorial working

53338b1

* Finished up notebooks * Changed startup logic to accomodate multitenent use and mediation ** This means passing a different env yaml file by setting a flag in manage

morrieinmaas added 4 commits March 18, 2021 22:19

Clean up notebooks

9fb582c

Merge branch 'master' into issue_61

65c1483

Minor fixes and tidying

d47519b

Working complete multiteant tutorials

eefd4af

* manually checked

morrieinmaas force-pushed the issue_61 branch from 385bd4f to eefd4af Compare March 18, 2021 23:36

Remove redundant dependency

cf7cad5

morrieinmaas changed the title ~~[WIP] Major refactor of tutorial folder structure.~~ Major refactor of tutorial folder structure. Mar 19, 2021

Tidying up and fixing logical error in token assignment in aries

890f059

controller

Remove unwanted tutorial notebooks of om pki lesson

b74af56

clean multi-tennant tutorial

5b60f4b

wip-abramson reviewed Mar 19, 2021

View reviewed changes

wip-abramson approved these changes Mar 19, 2021

View reviewed changes

wip-abramson merged commit 7ebed18 into OpenMined:master Mar 19, 2021

TimoGlastra deleted the issue_61 branch November 10, 2021 16:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Major refactor of tutorial folder structure. #70

Major refactor of tutorial folder structure. #70

morrieinmaas commented Mar 3, 2021

wip-abramson commented Mar 9, 2021

morrieinmaas commented Mar 9, 2021

wip-abramson Mar 12, 2021

wip-abramson Mar 12, 2021

wip-abramson Mar 12, 2021

morrieinmaas commented Mar 19, 2021

lohanspies commented Mar 19, 2021

wip-abramson Mar 19, 2021

wip-abramson left a comment

Major refactor of tutorial folder structure. #70

Major refactor of tutorial folder structure. #70

Conversation

morrieinmaas commented Mar 3, 2021

Description

Checklist

wip-abramson commented Mar 9, 2021

morrieinmaas commented Mar 9, 2021

wip-abramson Mar 12, 2021

Choose a reason for hiding this comment

wip-abramson Mar 12, 2021

Choose a reason for hiding this comment

wip-abramson Mar 12, 2021

Choose a reason for hiding this comment

morrieinmaas commented Mar 19, 2021

lohanspies commented Mar 19, 2021

wip-abramson Mar 19, 2021

Choose a reason for hiding this comment

wip-abramson left a comment

Choose a reason for hiding this comment