Skip to content

refactor: Rename session_data related vars to clarify interaction with DB #302

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

Merged
merged 3 commits into from
Apr 5, 2023

Conversation

KShivendu
Copy link
Contributor

Summary of change

Rename sessionData related vars to clarity interaction with DB

Related issues

Checklist for important updates

  • Changelog has been updated
  • coreDriverInterfaceSupported.json file has been updated (if needed)
    • Along with the associated array in supertokens_python/constants.py
  • frontendDriverInterfaceSupported.json file has been updated (if needed)
  • Changes to the version if needed
    • In setup.py
    • In supertokens_python/constants.py
  • Had installed and ran the pre-commit hook
  • Issue this PR against the latest non released version branch.
    • To know which one it is, run find the latest released tag (git tag) in the format vX.Y.Z, and then find the latest branch (git branch --all) whose X.Y is greater than the latest released tag.
    • If no such branch exists, then create one from the latest released branch.
  • If have added a new web framework, update the supertokens_python/utils.py file to include that in the FRAMEWORKS variable
  • If added a new recipe that has a User type with extra info, then be sure to change the User type in supertokens_python/types.py

@KShivendu KShivendu force-pushed the session-data-rename branch from 081d7cf to bc2fc37 Compare March 30, 2023 13:15
Copy link
Collaborator

@porcellus porcellus left a comment

Choose a reason for hiding this comment

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

Minor typo, otherwise LGTM.

CHANGELOG.md Outdated
@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## unreleased

### Breaking changes

- Rename `get_session_data` to `get_session_data_from_database` to clarity that it always hits the DB
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- Rename `get_session_data` to `get_session_data_from_database` to clarity that it always hits the DB
- Renamed `get_session_data` to `get_session_data_from_database` to clarity that it always hits the DB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

@porcellus
Copy link
Collaborator

There are a few comments in the examples that you may need to update; please check those as well.

@porcellus porcellus merged commit dd26224 into feat/access-token-v3 Apr 5, 2023
@porcellus porcellus deleted the session-data-rename branch April 5, 2023 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants