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

RHIDP-1149: Enable Auto Logout feature by default, provide configuration options and documentation #944

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

coreydaley
Copy link
Member

@coreydaley coreydaley commented Feb 1, 2024

Description

  • Modified packages/app/src/components/AppBase/AppBase.tsx to include the AutoLogout component, enables by default and includes the defaults recommended by Backstage.
  • Modified app-config.yaml to include options to modify the Auto Logout feature using environment variables.
  • Updated showcase-docs/getting-started.md to include information about Secure by Default, having the Auto Logout feature enabled by default, and how to modify that configuration.

Which issue(s) does this PR fix

PR acceptance criteria

Please make sure that the following steps are complete:

  • GitHub Actions are completed and successful
  • Unit Tests are updated and passing
  • E2E Tests are updated and passing
  • Documentation is updated if necessary (requirement for new features)
  • Add a screenshot if the change is UX/UI related

How to test changes / Special notes to the reviewer

The Auto Logout feature does not work using the Guest login and was tested using the Github login feature.

@coreydaley coreydaley requested a review from a team as a code owner February 1, 2024 21:01
Copy link

changeset-bot bot commented Feb 1, 2024

⚠️ No Changeset found

Latest commit: 0d506ee

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coreydaley coreydaley force-pushed the 2024-02-01-RHIDP-1149-enable-auto-logout-by-default branch from 69b6f32 to 0d506ee Compare February 1, 2024 21:08
Copy link

sonarcloud bot commented Feb 1, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@coreydaley
Copy link
Member Author

/assign @kadel

Copy link

janus-idp bot commented Feb 1, 2024

backstage-showcase Tests on commit 2d1d61f finished with errors.
View test log

Copy link
Contributor

github-actions bot commented Feb 1, 2024

The image is available at: quay.io/janus-idp/backstage-showcase:pr-944!

@gashcrumb
Copy link
Member

I took a moment to try this locally but when running yarn start I see this error; maybe this dependency comes from the autologout component and just needs to be added to the package.json.

Screenshot from 2024-02-08 11-09-49

@gashcrumb
Copy link
Member

I took a moment to try this locally but when running yarn start I see this error; maybe this dependency comes from the autologout component and just needs to be added to the package.json.

Never mind this, gave it another try and didn't have this error again. Autologout feature worked for me too, great!

Copy link
Member

@gashcrumb gashcrumb left a comment

Choose a reason for hiding this comment

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

If we're keeping changelogs this PR will need one, but other than that looks good to me.

Copy link

openshift-ci bot commented Feb 8, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: gashcrumb
Once this PR has been reviewed and has the lgtm label, please ask for approval from kadel. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@coreydaley
Copy link
Member Author

/hold
According to backstage/backstage#22692 (comment), the AutoLogout feature may introduce a false sense of security and not actually completely log the user out. Further investigation may be needed, or this may not be worth enabling.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add the auto logout feature
3 participants