FEAT: refresh sessions automatically #507

NoahCardoza · 2021-09-17T17:20:38Z

This is a start to addressing the issue outlined in #292.

While I think it should work for every type of login, I'm not sure it's the best way. I'm pretty new to Salesforce and I'm pretty sure I've seen some documentation about actual refresh tokens which I have not incorporated.

This PR also needs tests set up. While I started, I don't have too much experience writing good tests and don't have much time at the moment. However, I can get to that later. I figure it would be more helpful to get this out and figure out testing in the future.

NoahCardoza · 2021-09-17T19:16:59Z

simple_salesforce/api.py

@@ -207,6 +212,20 @@ def __init__(

        self.api_usage = {}

+    def _generate_headers(self):


Extract this to a new method since it will be used in two places.

NoahCardoza · 2021-09-17T19:18:12Z

simple_salesforce/api.py

+            'X-PrettyPrint': '1'
+        }
+
+    def _refresh_session(self):


Run the login logic cached in __init__ and recalculate the headers with the new session_id.

NoahCardoza · 2021-09-17T21:06:13Z

simple_salesforce/api.py

@@ -124,7 +126,8 @@ def __init__(
            self.auth_type = "password"

            # Pass along the username/password to our login helper
-            self.session_id, self.sf_instance = SalesforceLogin(
+            self._salesforce_login_partial = partial(


I'm basically using partial to cache the values passed to SalesforceLogin in _salesforce_login_partial so later when our session expires, we can just call SalesforceLogin again and get a new token.

NoahCardoza · 2021-09-17T21:07:21Z

simple_salesforce/api.py

@@ -148,13 +152,17 @@ def __init__(
                    self.sf_instance += ':' + str(port)
            else:
                self.sf_instance = instance
+
+            # Only generate the headers wihtout logging in first
+            self._generate_headers()


Since we don't actually perform a login here, we have to remember to generate the headers (usually done in the _refresh_session method).

NoahCardoza · 2021-09-17T21:09:20Z

simple_salesforce/api.py

@@ -679,6 +713,12 @@ def __init__(
                                     object_name=object_name,
                                     sf_version=sf_version))

+    @property
+    def session_id(self):


I use a property here to make it backward compatible with the tests already in place. However, if this officially gets merged in we'd probably want to just pass most everything through the salesforce parameter.

…salesforce#485) Co-authored-by: Adam <adamm@ownbackup.com>

* Added support for all metadata api operations * Update metadata.py to support bulk api like syntax * Update metadata.py * Update metadata.py * Fixed docstrings * Update metadata.py Changed new() method to __call__ for easier syntax when creating new objects. Added flag to zeep settings so that out of order complex types are parsed successfully in read response * Update metadata.py * Added documentation for metadata API operations * Update MANIFEST.in * Update metadata.py * Update api.py * Update metadata.py * Update metadata.py * Update metadata.py * Update metadata.py * Moved sandbox from class variable to method parameter * Update api.py Co-authored-by: pdahiya <pdahiya@commvault.com>

…imple-salesforce#518) * Issue simple-salesforce#517 Fixing hanging batch results in worker. * Issue simple-salesforce#517 Found another use of Not Processed and changed to NotProcessed. Co-authored-by: Martin Gardner (Slalom) <martin.gardner@slalom.com>

Co-authored-by: JonWobken <49450080+jon-wobken@users.noreply.github.com>

…imple-salesforce#495) * Add parse_float function to allow parsing floats to decimal.Decimal * Refactor json parsing into separate functions * Fix linting * Add parse_float test to SFType tests * Fix linting in test * Check types in test for SFType Co-authored-by: JonWobken <49450080+jon-wobken@users.noreply.github.com>

fix pylint line too long

fix travis-ci cryptography build error

fix formatting error in update_base64

fix travis-ci pyp3 build error with crytography

remove pypy3 failing due to cartography build

shanehh · 2022-04-26T06:38:12Z

Hi simple-salesforce team.. please merge this PR?

dansmachina · 2022-05-18T12:43:42Z

Hi! Following up on this feature, it would be really nice to have it 🥇

fix pylint trailing whitespaces/line too long

fix pylint errors (white space, line too long, too many lines)

jon-wobken · 2022-05-25T15:05:49Z

simple_salesforce/api.py

@@ -129,7 +126,8 @@ def __init__(
            self.auth_type = "password"

            # Pass along the username/password to our login helper
-            self.session_id, self.sf_instance = SalesforceLogin(
+            self._salesforce_login_partial = partial(


Should be a quick addition but should ensure that it supports the OAuth and Security token login options

Pass through OAuth arguments

Pass through security token arguments

Just saw this! Summer is coming up soon and I'll likely resume the project I was using this for and thus have time to take a look at this. I'll look into it and come back if I have any questions.

Thanks for taking a look!

fix pylint errors

Ignore protected class

pylint disable W0212

* FEAT: refresh sessions automatically (#507) * add support for refreshing sessions automatically * recalculate headers with new session_id * fix tests * extend support to SFType objects as well * reach into Salesforce from SFType to refresh session * fix session_id getter * rearrange arguments when creating SFType * Update CHANGES * Added upload_base64, update_base64, get_base64 functionality (#485) Co-authored-by: Adam <adamm@ownbackup.com> * Added support for all metadata api operations (#475) * Added support for all metadata api operations * Update metadata.py to support bulk api like syntax * Update metadata.py * Update metadata.py * Fixed docstrings * Update metadata.py Changed new() method to __call__ for easier syntax when creating new objects. Added flag to zeep settings so that out of order complex types are parsed successfully in read response * Update metadata.py * Added documentation for metadata API operations * Update MANIFEST.in * Update metadata.py * Update api.py * Update metadata.py * Update metadata.py * Update metadata.py * Update metadata.py * Moved sandbox from class variable to method parameter * Update api.py Co-authored-by: pdahiya <pdahiya@commvault.com> * Issue #517 Fixing hanging batch results in worker. (#518) * Issue #517 Fixing hanging batch results in worker. * Issue #517 Found another use of Not Processed and changed to NotProcessed. Co-authored-by: Martin Gardner (Slalom) <martin.gardner@slalom.com> * Update default api version to Winter 22 (#515) Co-authored-by: JonWobken <49450080+jon-wobken@users.noreply.github.com> * update link for sfdc jwt (#512) * Add parse_float function to allow parsing floats to decimal.Decimal (#495) * Add parse_float function to allow parsing floats to decimal.Decimal * Refactor json parsing into separate functions * Fix linting * Add parse_float test to SFType tests * Fix linting in test * Check types in test for SFType Co-authored-by: JonWobken <49450080+jon-wobken@users.noreply.github.com> * Update __version__.py * Update CHANGES * Update .pylintrc * Update metadata.py fix pylint line too long * Update api.py fix pylint line too long * Update .travis.yml fix travis-ci cryptography build error * Update api.py fix formatting error in update_base64 * Update metadata.py * Update api.py * Update .travis.yml fix travis-ci cryptography build * Add kwargs to query_more call in query_all_iter (#524) * Update .travis.yml fix travis-ci cryography compile * Update .travis.yml * Update .travis.yml * Update .travis.yml * Update .travis.yml * Update setup.py fix travis-ci pyp3 build error with crytography * Update .travis.yml * Update .travis.yml * Update .travis.yml * Update .travis.yml * Update .travis.yml * Update .travis.yml remove pypy3 failing due to cartography build * Update api.py fix pylint trailing whitespaces/line too long * Update api.py fix pylint errors (white space, line too long, too many lines) * Update api.py * Update api.py fix pylint errors * Update api.py Ignore protected class * Update test_api.py pylint disable W0212 Co-authored-by: JonWobken <49450080+jon-wobken@users.noreply.github.com> Co-authored-by: Adam Mahameed <23741427+adam-mah@users.noreply.github.com> Co-authored-by: Adam <adamm@ownbackup.com> Co-authored-by: Pranav Dahiya <31065394+pranav-dahiya@users.noreply.github.com> Co-authored-by: pdahiya <pdahiya@commvault.com> Co-authored-by: magardner <magardner@users.noreply.github.com> Co-authored-by: Martin Gardner (Slalom) <martin.gardner@slalom.com> Co-authored-by: Uli Stärk <github@uli-staerk.de> Co-authored-by: Matthew Nataloni <27374786+men6288@users.noreply.github.com> Co-authored-by: Timo <6358247+timotk@users.noreply.github.com> Co-authored-by: will-hall <77327489+will-hall@users.noreply.github.com> * Update .travis.yml * Update .travis.yml * Update .travis.yml * Update .travis.yml * Update api.py * Update .pylintrc Co-authored-by: Noah Cardoza <noahcardoza@gmail.com> Co-authored-by: Adam Mahameed <23741427+adam-mah@users.noreply.github.com> Co-authored-by: Adam <adamm@ownbackup.com> Co-authored-by: Pranav Dahiya <31065394+pranav-dahiya@users.noreply.github.com> Co-authored-by: pdahiya <pdahiya@commvault.com> Co-authored-by: magardner <magardner@users.noreply.github.com> Co-authored-by: Martin Gardner (Slalom) <martin.gardner@slalom.com> Co-authored-by: Uli Stärk <github@uli-staerk.de> Co-authored-by: Matthew Nataloni <27374786+men6288@users.noreply.github.com> Co-authored-by: Timo <6358247+timotk@users.noreply.github.com> Co-authored-by: will-hall <77327489+will-hall@users.noreply.github.com>

* Remove support for python 3.5 Remove support for python 3.5 * Remove support for python 3.5 Remove support for python 3.5 * Update __version__.py update version to v1.12.0 * Implement wait param in non-query bulk operations (#545) * Implement wait param in non-query bulk operations Add the wait parameter to workers spawned from _bulk_operation for non-query calls (it already exists for query calls). * Mimic formatting Co-authored-by: David Arcuri <david.arcuri@consultch.com> * Add optional flag use ordinary dict (#548) * add object_pairs_hook option * add object_pairs_hook to SFType * set attribute _object_pairs_hook * modify param desc to pass line limit pylint * added tests * updated corrected tests * Update test_api.py fix result = client.query to match response mock in test_query_parse_to_json_to_Dict and test_query_parse_to_json_to_OrderedDict * Update test_api.py update test names to fix pylint invalid-name * fix trailing whitespace fix trailing whitespace Co-authored-by: JonWobken <49450080+jon-wobken@users.noreply.github.com> * create dynamic sized batches to respect bulk api limits (#546) * add autosize feature * add docstring * add support for char_limit Co-authored-by: Hal Ali <hal.ali@agilebits.com> * Feature/release/v1.12.0/refresh session (#555) * FEAT: refresh sessions automatically (#507) * add support for refreshing sessions automatically * recalculate headers with new session_id * fix tests * extend support to SFType objects as well * reach into Salesforce from SFType to refresh session * fix session_id getter * rearrange arguments when creating SFType * Update CHANGES * Added upload_base64, update_base64, get_base64 functionality (#485) Co-authored-by: Adam <adamm@ownbackup.com> * Added support for all metadata api operations (#475) * Added support for all metadata api operations * Update metadata.py to support bulk api like syntax * Update metadata.py * Update metadata.py * Fixed docstrings * Update metadata.py Changed new() method to __call__ for easier syntax when creating new objects. Added flag to zeep settings so that out of order complex types are parsed successfully in read response * Update metadata.py * Added documentation for metadata API operations * Update MANIFEST.in * Update metadata.py * Update api.py * Update metadata.py * Update metadata.py * Update metadata.py * Update metadata.py * Moved sandbox from class variable to method parameter * Update api.py Co-authored-by: pdahiya <pdahiya@commvault.com> * Issue #517 Fixing hanging batch results in worker. (#518) * Issue #517 Fixing hanging batch results in worker. * Issue #517 Found another use of Not Processed and changed to NotProcessed. Co-authored-by: Martin Gardner (Slalom) <martin.gardner@slalom.com> * Update default api version to Winter 22 (#515) Co-authored-by: JonWobken <49450080+jon-wobken@users.noreply.github.com> * update link for sfdc jwt (#512) * Add parse_float function to allow parsing floats to decimal.Decimal (#495) * Add parse_float function to allow parsing floats to decimal.Decimal * Refactor json parsing into separate functions * Fix linting * Add parse_float test to SFType tests * Fix linting in test * Check types in test for SFType Co-authored-by: JonWobken <49450080+jon-wobken@users.noreply.github.com> * Update __version__.py * Update CHANGES * Update .pylintrc * Update metadata.py fix pylint line too long * Update api.py fix pylint line too long * Update .travis.yml fix travis-ci cryptography build error * Update api.py fix formatting error in update_base64 * Update metadata.py * Update api.py * Update .travis.yml fix travis-ci cryptography build * Add kwargs to query_more call in query_all_iter (#524) * Update .travis.yml fix travis-ci cryography compile * Update .travis.yml * Update .travis.yml * Update .travis.yml * Update .travis.yml * Update setup.py fix travis-ci pyp3 build error with crytography * Update .travis.yml * Update .travis.yml * Update .travis.yml * Update .travis.yml * Update .travis.yml * Update .travis.yml remove pypy3 failing due to cartography build * Update api.py fix pylint trailing whitespaces/line too long * Update api.py fix pylint errors (white space, line too long, too many lines) * Update api.py * Update api.py fix pylint errors * Update api.py Ignore protected class * Update test_api.py pylint disable W0212 Co-authored-by: JonWobken <49450080+jon-wobken@users.noreply.github.com> Co-authored-by: Adam Mahameed <23741427+adam-mah@users.noreply.github.com> Co-authored-by: Adam <adamm@ownbackup.com> Co-authored-by: Pranav Dahiya <31065394+pranav-dahiya@users.noreply.github.com> Co-authored-by: pdahiya <pdahiya@commvault.com> Co-authored-by: magardner <magardner@users.noreply.github.com> Co-authored-by: Martin Gardner (Slalom) <martin.gardner@slalom.com> Co-authored-by: Uli Stärk <github@uli-staerk.de> Co-authored-by: Matthew Nataloni <27374786+men6288@users.noreply.github.com> Co-authored-by: Timo <6358247+timotk@users.noreply.github.com> Co-authored-by: will-hall <77327489+will-hall@users.noreply.github.com> * Update .travis.yml * Update .travis.yml * Update .travis.yml * Update .travis.yml * Update api.py * Update .pylintrc Co-authored-by: Noah Cardoza <noahcardoza@gmail.com> Co-authored-by: Adam Mahameed <23741427+adam-mah@users.noreply.github.com> Co-authored-by: Adam <adamm@ownbackup.com> Co-authored-by: Pranav Dahiya <31065394+pranav-dahiya@users.noreply.github.com> Co-authored-by: pdahiya <pdahiya@commvault.com> Co-authored-by: magardner <magardner@users.noreply.github.com> Co-authored-by: Martin Gardner (Slalom) <martin.gardner@slalom.com> Co-authored-by: Uli Stärk <github@uli-staerk.de> Co-authored-by: Matthew Nataloni <27374786+men6288@users.noreply.github.com> Co-authored-by: Timo <6358247+timotk@users.noreply.github.com> Co-authored-by: will-hall <77327489+will-hall@users.noreply.github.com> * Support OAuth2 endpoint APIs (#550) OAuth Endpoints (https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_endpoints.htm&type=5) Co-authored-by: JonWobken <49450080+jon-wobken@users.noreply.github.com> * Update CHANGES Co-authored-by: David A <45184827+Haeilifax@users.noreply.github.com> Co-authored-by: David Arcuri <david.arcuri@consultch.com> Co-authored-by: sohith <77746813+sohithkumar@users.noreply.github.com> Co-authored-by: Hal Ali <haleemur@users.noreply.github.com> Co-authored-by: Hal Ali <hal.ali@agilebits.com> Co-authored-by: Noah Cardoza <noahcardoza@gmail.com> Co-authored-by: Adam Mahameed <23741427+adam-mah@users.noreply.github.com> Co-authored-by: Adam <adamm@ownbackup.com> Co-authored-by: Pranav Dahiya <31065394+pranav-dahiya@users.noreply.github.com> Co-authored-by: pdahiya <pdahiya@commvault.com> Co-authored-by: magardner <magardner@users.noreply.github.com> Co-authored-by: Martin Gardner (Slalom) <martin.gardner@slalom.com> Co-authored-by: Uli Stärk <github@uli-staerk.de> Co-authored-by: Matthew Nataloni <27374786+men6288@users.noreply.github.com> Co-authored-by: Timo <6358247+timotk@users.noreply.github.com> Co-authored-by: will-hall <77327489+will-hall@users.noreply.github.com> Co-authored-by: Hiroki Kajiwara <hkajiwara@gmail.com>

NoahCardoza added 3 commits September 17, 2021 10:05

add support for refreshing sessions automatically

5cc2574

recalculate headers with new session_id

07fec83

fix tests

8e04268

NoahCardoza force-pushed the auto-renew-session branch from 3644693 to 8e04268 Compare September 17, 2021 18:46

extend support to SFType objects as well

f1830e3

NoahCardoza commented Sep 17, 2021

View reviewed changes

NoahCardoza added 3 commits September 17, 2021 12:24

reach into Salesforce from SFType to refresh session

b6324d8

fix session_id getter

4720172

rearrange arguments when creating SFType

c7f1fd5

NoahCardoza commented Sep 17, 2021

View reviewed changes

NoahCardoza mentioned this pull request Sep 17, 2021

Check session status, avoid SalesforceExpiredSession #292

Open

jon-wobken and others added 6 commits January 5, 2022 09:25

Update CHANGES

b0a3563

Added upload_base64, update_base64, get_base64 functionality (simple-…

f264a0a

…salesforce#485) Co-authored-by: Adam <adamm@ownbackup.com>

Update default api version to Winter 22 (simple-salesforce#515)

7abde30

Co-authored-by: JonWobken <49450080+jon-wobken@users.noreply.github.com>

update link for sfdc jwt (simple-salesforce#512)

9d3aa44

jon-wobken changed the base branch from master to release/v1.11.5 January 5, 2022 15:45

timotk and others added 9 commits January 5, 2022 09:59

Update __version__.py

9b06da7

Update CHANGES

09c1a7c

Update .pylintrc

fd21372

Update metadata.py

7c34ca1

fix pylint line too long

Update api.py

a58f6de

fix pylint line too long

Update .travis.yml

8d14363

fix travis-ci cryptography build error

Update api.py

14058ac

fix formatting error in update_base64

Update metadata.py

54939a0

jon-wobken added 9 commits January 31, 2022 17:02

Update .travis.yml

eae363c

Update .travis.yml

d61b6f8

Update setup.py

eb04e93

fix travis-ci pyp3 build error with crytography

Update .travis.yml

1cd12c0

Update .travis.yml

dd8a412

Update .travis.yml

be8efef

Update .travis.yml

37fa83f

Update .travis.yml

19c0b90

Update .travis.yml

e98fa53

remove pypy3 failing due to cartography build

jon-wobken added the Backlog Issue will be looked at sometime in the future label Feb 1, 2022

Merge branch 'release/v1.11.5' into auto-renew-session

a8bb607

jon-wobken changed the base branch from release/v1.11.5 to release/v1.12.0 May 23, 2022 17:55

jon-wobken self-assigned this May 23, 2022

jon-wobken added the In Review label May 23, 2022

jon-wobken added 4 commits May 24, 2022 10:44

Merge branch 'release/v1.12.0' into auto-renew-session

e5ee6cc

Update api.py

82deb77

fix pylint trailing whitespaces/line too long

Update api.py

48089a6

fix pylint errors (white space, line too long, too many lines)

Update api.py

0435022

jon-wobken reviewed May 25, 2022

View reviewed changes

jon-wobken added 3 commits May 25, 2022 12:23

Update api.py

751fa22

fix pylint errors

Update api.py

b1b6011

Ignore protected class

Update test_api.py

b0bc8d6

pylint disable W0212

jon-wobken changed the base branch from release/v1.12.0 to feature/release/v1.12.0/refresh_session July 13, 2022 14:49

jon-wobken merged commit bd39ec4 into simple-salesforce:feature/release/v1.12.0/refresh_session Jul 13, 2022

hkajiwara mentioned this pull request Jul 16, 2022

Breaking change in 1.12.0 #557

Closed

chrismaes87 mentioned this pull request Aug 8, 2022

infinite recursion when login returns 401 #569

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FEAT: refresh sessions automatically #507

FEAT: refresh sessions automatically #507

NoahCardoza commented Sep 17, 2021

NoahCardoza Sep 17, 2021

NoahCardoza Sep 17, 2021

NoahCardoza Sep 17, 2021

NoahCardoza Sep 17, 2021

NoahCardoza Sep 17, 2021

shanehh commented Apr 26, 2022

dansmachina commented May 18, 2022

jon-wobken May 25, 2022 •

edited

NoahCardoza Jun 22, 2022

		@@ -207,6 +212,20 @@ def __init__(

		self.api_usage = {}

		def _generate_headers(self):

FEAT: refresh sessions automatically #507

FEAT: refresh sessions automatically #507

Conversation

NoahCardoza commented Sep 17, 2021

NoahCardoza Sep 17, 2021

Choose a reason for hiding this comment

NoahCardoza Sep 17, 2021

Choose a reason for hiding this comment

NoahCardoza Sep 17, 2021

Choose a reason for hiding this comment

NoahCardoza Sep 17, 2021

Choose a reason for hiding this comment

NoahCardoza Sep 17, 2021

Choose a reason for hiding this comment

shanehh commented Apr 26, 2022

dansmachina commented May 18, 2022

jon-wobken May 25, 2022 • edited

Choose a reason for hiding this comment

NoahCardoza Jun 22, 2022

Choose a reason for hiding this comment

jon-wobken May 25, 2022 •

edited