Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating demo_scopes.json #5737

Merged
merged 10 commits into from
Jan 5, 2023
Merged

Updating demo_scopes.json #5737

merged 10 commits into from
Jan 5, 2023

Conversation

Thingus
Copy link
Contributor

@Thingus Thingus commented Jan 3, 2023

Closes #5735

I have:

  • Formatted any Python files with black
  • Brought the branch up to date with master
  • Added any relevant Github labels
  • Added tests for any new additions
  • Added or updated any relevant documentation
  • Added an Architectural Decision Record (ADR), if appropriate
  • Added an MPLv2 License Header if appropriate
  • Updated the Changelog

Description

Updates Flowauth quickstart to work with worked examples


@cypress
Copy link

cypress bot commented Jan 3, 2023



Test summary

4 0 0 0Flakiness 0


Run details

Project FlowAuth
Status Passed
Commit 1b57efa
Started Jan 5, 2023 9:21 AM
Ended Jan 5, 2023 9:22 AM
Duration 00:49 💡
OS Linux Debian -
Browser Electron 106

View run in Cypress Dashboard ➡️


This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

@codecov
Copy link

codecov bot commented Jan 4, 2023

Codecov Report

Merging #5737 (1b57efa) into master (d095001) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #5737      +/-   ##
==========================================
- Coverage   93.24%   93.24%   -0.01%     
==========================================
  Files         277      277              
  Lines       10828    10829       +1     
  Branches      895      895              
==========================================
  Hits        10097    10097              
  Misses        602      602              
- Partials      129      130       +1     
Impacted Files Coverage Δ
flowauth/backend/flowauth/models.py 89.31% <100.00%> (+0.04%) ⬆️
flowmachine/flowmachine/core/cache.py 92.30% <0.00%> (-0.39%) ⬇️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@Thingus Thingus marked this pull request as ready for review January 4, 2023 10:36
@Thingus Thingus requested a review from jc-harrison January 4, 2023 10:36
@Thingus
Copy link
Contributor Author

Thingus commented Jan 4, 2023

I think that just adding the admin3 scopes to the default role should be enough to make all the worked examples workable - @jc-harrison can you confirm?

@Thingus Thingus added FlowAuth Issues related to FlowAuth quick-start-script docs Documentation issues Needs Review PR that is ready for review by a human labels Jan 4, 2023
@jc-harrison
Copy link
Member

I think that just adding the admin3 scopes to the default role should be enough to make all the worked examples workable - @jc-harrison can you confirm?

I think admin3 is all that's needed for the worked examples, but I think I'd argue for enabling all queries in the demo roles - the main purpose of the quick-start is to enable people to try running FlowKit queries, so I think it's good if users can modify the queries as they like and still be able to run them without needing to understand how to enter FlowAuth admin mode and enable more scopes.

@jc-harrison
Copy link
Member

Linking this issue here for visibility - at some point it would be good to modify the quick-start so that FlowAuth demo data is populated from the quick-started FlowAPI spec, rather than from a hard-coded pre-defined spec.

@Thingus
Copy link
Contributor Author

Thingus commented Jan 4, 2023

I think admin3 is all that's needed for the worked examples, but I think I'd argue for enabling all queries in the demo roles - the main purpose of the quick-start is to enable people to try running FlowKit queries, so I think it's good if users can modify the queries as they like and still be able to run them without needing to understand how to enter FlowAuth admin mode and enable more scopes.

I'm inclined to agree there - I think that when an org gets into the situation that they'll be needing the finer-grained auth tools, they're probably past the quickstart. Will update.

Given that the token has both roles, this should make all queries in quickstart runnable.
Copy link
Member

@jc-harrison jc-harrison left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I've tried running through the worked examples in a quick-start deployment, and it's all working fine.

@Thingus Thingus added ready-to-merge Label indicating a PR is OK to automerge and removed Needs Review PR that is ready for review by a human labels Jan 5, 2023
@mergify mergify bot merged commit 0c9c150 into master Jan 5, 2023
@mergify mergify bot deleted the quickstart_update branch January 5, 2023 09:33
@Thingus Thingus restored the quickstart_update branch January 5, 2023 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation issues FlowAuth Issues related to FlowAuth quick-start-script ready-to-merge Label indicating a PR is OK to automerge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

FlowclientConnectionError: User claims verification failed
2 participants