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.

Sign up for GitHub

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

Jump to bottom

Fixes #3028

Merged

ouziel-slama merged 11 commits into develop from fixes

Feb 19, 2025

Contributor

ouziel-slama commented Feb 18, 2025 •

edited

Loading

Accept --catch-up flag before the command
Make RSFecther less verbose
Add locust runner to test local node
Refactor shutdown
- KISS: we don't try to close all connections anymore, sqlite3 is designed for that. This ensures that all processes are
  properly stopped and that the API port is released.
- Using a CounterparyServer thread, which is started with start() and stopped with stop().
- Add an integration test for shutdown

Double-check the spelling and grammar of all strings, code comments, etc.
Double-check that all code is deterministic that needs to be
Add tests to cover any new or revised logic
Ensure that the test suite passes
Update the project release notes
Update the project documentation, as appropriate, with a corresponding Pull Request in the Documentation repository


          Accept --catch-up flag before the command

ouziel-slama mentioned this pull request

Order of CLI Arguments Should Not Matter #2514

Closed

codecov bot commented Feb 18, 2025 •

edited

Loading

Codecov Report

Attention: Patch coverage is 45.90164% with 66 lines in your changes missing coverage. Please review.

Project coverage is 77.61%. Comparing base (19559b5) to head (722bbb6).
Report is 15 commits behind head on develop.

Files with missing lines	Patch %	Lines
...unterparty-core/counterpartycore/lib/cli/server.py	51.08%	45 Missing ⚠️
...erparty-core/counterpartycore/lib/parser/follow.py	0.00%	13 Missing ⚠️
...erparty-core/counterpartycore/lib/api/apiserver.py	42.85%	4 Missing ⚠️
...arty-core/counterpartycore/lib/backend/bitcoind.py	33.33%	2 Missing ⚠️
...erparty-core/counterpartycore/lib/parser/blocks.py	0.00%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3028      +/-   ##
===========================================
- Coverage    80.65%   77.61%   -3.05%     
===========================================
  Files           99       99              
  Lines        13375    13390      +15     
===========================================
- Hits         10788    10393     -395     
- Misses        2587     2997     +410

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Ouziel added 4 commits

February 18, 2025 10:54


          Make RSFecther less verbose

e0a0fcc


          Add locust runner to test local node

2ee5021


          tweak locust runner

ccac71c


          better error handling for port taken; broken shutdown test

aa61fbe

github-advanced-security bot found potential problems

View reviewed changes

counterparty-core/counterpartycore/lib/api/apiserver.py

+                          wsgi_server = wsgi.WSGIApplication(app, args=args)
+                      except OSError as e:
+                          logger.error(f"Error starting WSGI Server: {e}")
+                          exit(1)

Check warning

Code scanning / pylint

Consider using 'sys.exit' instead. Warning

Consider using 'sys.exit' instead.


          refactor start all step 1

3a2eec7

github-advanced-security bot found potential problems

View reviewed changes

counterparty-core/counterpartycore/lib/cli/server.py Fixed Show fixed Hide fixed

counterparty-core/counterpartycore/lib/cli/server.py Fixed Show fixed Hide fixed

counterparty-core/counterpartycore/lib/cli/server.py

-                      if not k.startswith("__") and not k.startswith("DEFAULT_")
-                  }
-                  logger.debug(f"Config: {custom_config}")
+              class CounterpartyServer(threading.Thread):

Check warning

Code scanning / pylint

Too many instance attributes (12/7). Warning

Too many instance attributes (12/7).

counterparty-core/counterpartycore/lib/cli/server.py

+                      self.log_stream = log_stream
+                      # Log all config parameters, sorted by key
+                      # Filter out default values #TODO: these should be set in a different way

Check warning

Code scanning / pylint

Filter out default values #TODO: these should be set in a different way. Warning

Filter out default values #TODO: these should be set in a different way.

counterparty-core/counterpartycore/lib/cli/server.py

+                          server.join(1)
+                  except KeyboardInterrupt:
+                      logger.warning("Keyboard interrupt received. Shutting down...")
+                  except Exception as e:

Check warning

Code scanning / pylint

Catching too general exception Exception. Warning

Catching too general exception Exception.

Ouziel added 2 commits

February 19, 2025 08:36


          refactor shutdown step2

93908d0


          just don't close db connection like recommanded by apsw

4651b33

github-advanced-security bot found potential problems

View reviewed changes

counterparty-core/counterpartycore/lib/cli/server.py

@@ @@ -11,6 +11,7 @@ @@
               from urllib.parse import quote_plus as urlencode
               import appdirs
+              import apsw

Check warning

Code scanning / pylint

Unable to import 'apsw'. Warning

Unable to import 'apsw'.

counterparty-core/counterpartycore/lib/cli/server.py

+                              try:
+                                  check.asset_conservation(self.db, self.stop_event)
+                              except exceptions.SanityError as e:
+                                  logger.error("Asset conservation check failed: %s" % e)

Check warning

Code scanning / pylint

Use lazy % or .format() formatting in logging functions. Warning

Use lazy % or .format() formatting in logging functions.

counterparty-core/counterpartycore/lib/cli/server.py

+                              try:
+                                  check.asset_conservation(self.db, self.stop_event)
+                              except exceptions.SanityError as e:
+                                  logger.error("Asset conservation check failed: %s" % e)

Check warning

Code scanning / pylint

Formatting a regular string which could be an f-string. Warning

Formatting a regular string which could be an f-string.

counterparty-core/counterpartycore/lib/parser/follow.py

@@ @@ -255,7 +257,7 @@ @@
                       self.check_software_version_if_needed()
                       late_since = None
-                      while True:
+                      while True and not self.stop_event.is_set():

Check warning

Code scanning / pylint

Boolean condition "True and not self.stop_event.is_set()" may be simplified to "not self.stop_event.is_set()". Warning

Boolean condition "True and not self.stop_event.is_set()" may be simplified to "not self.stop_event.is_set()".

Ouziel added 2 commits

February 19, 2025 12:05


          KISS

bfd2180


          Shutdown test

d39ab24

ouziel-slama requested a review from adamkrellenstein

February 19, 2025 15:01

Base automatically changed from batch to develop

February 19, 2025 15:02

adamkrellenstein approved these changes

View reviewed changes


          complete release notes

722bbb6

ouziel-slama merged commit 2176230 into develop

31 of 33 checks passed

ouziel-slama deleted the fixes branch

February 19, 2025 19:59

ouziel-slama mentioned this pull request

Write a Test for Clean Shutdown #2733

Closed

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

Labels

None yet