test Demo #4701

gitofanindya · 2024-03-15T04:39:54Z

No description provided.

sourcery-ai

Hey @gitofanindya - I've reviewed your changes and found some issues that need to be addressed.

General suggestions:

Consider abstracting the HTTP request logic into a separate method or service to reduce code duplication and improve maintainability.
Externalize sensitive information such as URLs and credentials to configuration files or environment variables to enhance security.
Implement error handling for HTTP responses to gracefully handle cases where expected data might be missing or in an unexpected format.
Refactor the initialization and setup of new functionalities to maintain a clear separation of concerns and improve code readability.

Here's what I looked at during the review

🟡 General issues: 4 issues found
🔴 Security: 2 blocking issues, 1 other issue
🟢 Testing: all looks good
🟡 Complexity: 2 issues found
🟢 Docstrings: all looks good

Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨

Share Sourcery

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

sourcery-ai · 2024-03-15T04:41:25Z

nxdrive/gui/api.py

+    def fetch_pending_tasks(self, engine: Engine, /) -> None:
+        log.info("Check for pending approval tasks")
+        endpoint = "/api/v1/task/"
+        url = "http://localhost:8080/nuxeo" + endpoint
+        headers = {
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+        }
+        try:
+            # response = NuxeoClient.request(self,method="GET", path=endpoint, headers=headers, ssl_verify=Options.ssl_no_verify)
+            response = requests.get(
+                url=url,
+                verify=True,
+                timeout=3600,
+                headers=headers,
+                auth=("Administrator", "Administrator"),
+            )
+            log.info(f">>>>> response type: {type(response)}")
+            data = response.json()
+            log.info(f">>>> response: {data}")
+            if data["resultsCount"] > 0:
+                log.info("Send pending task notification")
+                for task in data["entries"]:
+                    log.info(f">>>> task: {task}")
+                    log.info(f">>>> taskid: {task['id']}")
+                    engine.fetch_pending_task_list(task["id"])
+
+        except Exception:
+            log.exception("Unable to fetch tasks")


🚨 suggestion (security): Hardcoding the URL and credentials within the fetch_pending_tasks method could pose a security risk and limit flexibility. Consider externalizing these values to a configuration file or environment variables to enhance security and make the application more adaptable to different environments.

sourcery-ai · 2024-03-15T04:41:25Z

nxdrive/gui/api.py

+        log.info("Check for pending approval tasks")
+        endpoint = "/api/v1/task/"
+        url = "http://localhost:8080/nuxeo" + endpoint
+        headers = {
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+        }
+        try:
+            # response = NuxeoClient.request(self,method="GET", path=endpoint, headers=headers, ssl_verify=Options.ssl_no_verify)
+            response = requests.get(
+                url=url,
+                verify=True,
+                timeout=3600,
+                headers=headers,
+                auth=("Administrator", "Administrator"),
+            )
+            log.info(f">>>>> response type: {type(response)}")
+            data = response.json()
+            log.info(f">>>> response: {data}")
+            if data["resultsCount"] > 0:
+                log.info("Send pending task notification")
+                for task in data["entries"]:
+                    log.info(f">>>> task: {task}")
+                    log.info(f">>>> taskid: {task['id']}")
+                    engine.fetch_pending_task_list(task["id"])
+
+        except Exception:
+            log.exception("Unable to fetch tasks")


issue (code_refinement): The use of a hardcoded URL (http://localhost:8080/nuxeo) in the fetch_pending_tasks method might not be suitable for production environments. It's recommended to use a configurable endpoint to ensure the application can be easily adapted to different server configurations without requiring code changes.

sourcery-ai · 2024-03-15T04:41:25Z

nxdrive/gui/api.py

+            response = requests.get(
+                url=url,
+                verify=True,
+                timeout=3600,
+                headers=headers,
+                auth=("Administrator", "Administrator"),
+            )


suggestion (performance): The fetch_pending_tasks method uses a very long timeout value (3600 seconds). While this might be necessary in some cases, it could also lead to the application appearing unresponsive if the server takes a long time to respond. Consider allowing this value to be configurable or implementing a more dynamic timeout strategy.

sourcery-ai · 2024-03-15T04:41:25Z

nxdrive/gui/api.py

+            if data["resultsCount"] > 0:
+                log.info("Send pending task notification")
+                for task in data["entries"]:
+                    log.info(f">>>> task: {task}")
+                    log.info(f">>>> taskid: {task['id']}")
+                    engine.fetch_pending_task_list(task["id"])


suggestion (edge_case_not_handled): The fetch_pending_tasks method assumes that the response will always contain a resultsCount and entries fields. It's a good practice to add error handling for cases where these fields might be missing or not in the expected format to prevent runtime errors.

sourcery-ai · 2024-03-15T04:41:25Z

nxdrive/gui/api.py

+    def get_title(self, uid: str, /) -> str:
+        endpoint = "/api/v1/task/"
+        url = "http://localhost:8080/nuxeo" + endpoint
+        headers = {
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+        }
+        try:
+            response = requests.get(
+                url=url,
+                verify=True,
+                timeout=3600,
+                headers=headers,
+                auth=("Administrator", "Administrator"),
+            )
+            data = response.json()
+            html = data["entries"][0]
+            html = html["variables"]
+            html = html["review_result"]
+            return html if html else "No Results To Show"
+
+        except Exception:
+            log.exception("Unable to fetch tasks")
+            return "No Results Found"


suggestion (code_refinement): The get_title method duplicates the logic for making a GET request to the Nuxeo server, which is already present in the fetch_pending_tasks method. Consider refactoring this into a separate utility function or service to avoid code duplication and simplify maintenance.

sourcery-ai · 2024-03-15T04:41:26Z

nxdrive/gui/api.py

+            html = data["entries"][0]
+            html = html["variables"]
+            html = html["review_result"]
+            return html if html else "No Results To Show"


suggestion (code-quality): Replace if-expression with or (or-if-exp-identity)

Suggested change

return html if html else "No Results To Show"

return html or "No Results To Show"

Explanation
Here we find ourselves setting a value if it evaluates to True, and otherwise
using a default.

The 'After' case is a bit easier to read and avoids the duplication of
input_currency.

It works because the left-hand side is evaluated first. If it evaluates to
true then currency will be set to this and the right-hand side will not be
evaluated. If it evaluates to false the right-hand side will be evaluated and
currency will be set to DEFAULT_CURRENCY.

sourcery-ai · 2024-03-15T04:41:26Z

nxdrive/gui/api.py

+    def fetch_pending_tasks(self, engine: Engine, /) -> None:
+        log.info("Check for pending approval tasks")
+        endpoint = "/api/v1/task/"
+        url = "http://localhost:8080/nuxeo" + endpoint


suggestion (code-quality): Use f-string instead of string concatenation (use-fstring-for-concatenation)

Suggested change

url = "http://localhost:8080/nuxeo" + endpoint

url = f"http://localhost:8080/nuxeo{endpoint}"

sourcery-ai · 2024-03-15T04:41:26Z

nxdrive/gui/api.py

+        result = {
+            k: v for k, v in sorted(result.items(), key=lambda item: item[1])
+        }  # noqa


suggestion (code-quality): Replace identity comprehension with call to collection constructor (identity-comprehension)

Suggested change

result = {

k: v for k, v in sorted(result.items(), key=lambda item: item[1])

} # noqa

result = dict(sorted(result.items(), key=lambda item: item[1]))

Explanation
Convert list/set/tuple comprehensions that do not change the input elements into.

Before

# List comprehensions [item for item in coll] [item for item in friends.names()] # Dict comprehensions {k: v for k, v in coll} {k: v for k, v in coll.items()} # Only if we know coll is a `dict` # Unneeded call to `.items()` dict(coll.items()) # Only if we know coll is a `dict` # Set comprehensions {item for item in coll}

After

# List comprehensions list(iter(coll)) list(iter(friends.names())) # Dict comprehensions dict(coll) dict(coll) # Unneeded call to `.items()` dict(coll) # Set comprehensions set(coll)

All these comprehensions are just creating a copy of the original collection.
They can all be simplified by simply constructing a new collection directly. The
resulting code is easier to read and shows the intent more clearly.

sourcery-ai · 2024-03-15T04:41:26Z

nxdrive/gui/api.py

+            engine = self._manager.engines.get(uid)
+            if engine:


suggestion (code-quality): Use named expression to simplify assignment and conditional (use-named-expression)

Suggested change

engine = self._manager.engines.get(uid)

if engine:

if engine := self._manager.engines.get(uid):

sourcery-ai · 2024-03-15T04:41:26Z

nxdrive/gui/api.py

+    @pyqtSlot(str, result=str)
+    def get_title(self, uid: str, /) -> str:
+        endpoint = "/api/v1/task/"
+        url = "http://localhost:8080/nuxeo" + endpoint


suggestion (code-quality): Use f-string instead of string concatenation (use-fstring-for-concatenation)

Suggested change

url = "http://localhost:8080/nuxeo" + endpoint

url = f"http://localhost:8080/nuxeo{endpoint}"

codecov · 2024-03-15T04:42:04Z

Codecov Report

Attention: Patch coverage is 20.23810% with 67 lines in your changes missing coverage. Please review.

Project coverage is 49.04%. Comparing base (0c5ab6f) to head (a5a74e7).
Report is 104 commits behind head on master.

Files	Patch %	Lines
nxdrive/gui/api.py	18.86%	43 Missing ⚠️
nxdrive/gui/application.py	0.00%	15 Missing ⚠️
nxdrive/engine/engine.py	37.50%	5 Missing ⚠️
nxdrive/notification.py	50.00%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4701      +/-   ##
==========================================
+ Coverage   45.21%   49.04%   +3.83%     
==========================================
  Files          93       94       +1     
  Lines       15638    15764     +126     
==========================================
+ Hits         7071     7732     +661     
+ Misses       8567     8032     -535

Flag	Coverage Δ
functional	`37.94% <20.23%> (+2.12%)`	⬆️
integration	`2.05% <0.00%> (+0.06%)`	⬆️
unit	`37.45% <7.14%> (+1.87%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

gitofanindya and others added 16 commits May 10, 2023 17:13

sweta 001

c9a9131

sweta 002

120052b

Update api.py

efbf3ad

sweta 003

1eeb31f

Update engine.py 01

0fefcc5

Update application.py

a77f5f8

Update application.py 002

f0485e9

Update i18n.json roy

9d00ed3

Update Main.qml roy

57ecc7d

Update SystrayMenu.qml roy

a460b3c

Create TaskManager.qml roy

34332b3

Update api.py roy

aaefe0a

Update application.py roy

a5e1301

Update api.py roy 001

2f9cdc4

Update api.py roy003

f47b4df

Update engine.py

a5a74e7

sourcery-ai bot reviewed Mar 15, 2024

View reviewed changes

gitofanindya closed this Aug 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test Demo #4701

test Demo #4701

gitofanindya commented Mar 15, 2024

sourcery-ai bot left a comment

sourcery-ai bot Mar 15, 2024

sourcery-ai bot Mar 15, 2024

sourcery-ai bot Mar 15, 2024

sourcery-ai bot Mar 15, 2024

sourcery-ai bot Mar 15, 2024

sourcery-ai bot Mar 15, 2024

sourcery-ai bot Mar 15, 2024

sourcery-ai bot Mar 15, 2024

sourcery-ai bot Mar 15, 2024

sourcery-ai bot Mar 15, 2024

codecov bot commented Mar 15, 2024 •

edited

Loading

	return html if html else "No Results To Show"
	return html or "No Results To Show"

	url = "http://localhost:8080/nuxeo" + endpoint
	url = f"http://localhost:8080/nuxeo{endpoint}"

	engine = self._manager.engines.get(uid)
	if engine:
	if engine := self._manager.engines.get(uid):

test Demo #4701

test Demo #4701

Conversation

gitofanindya commented Mar 15, 2024

sourcery-ai bot left a comment

Choose a reason for hiding this comment

sourcery-ai bot Mar 15, 2024

Choose a reason for hiding this comment

sourcery-ai bot Mar 15, 2024

Choose a reason for hiding this comment

sourcery-ai bot Mar 15, 2024

Choose a reason for hiding this comment

sourcery-ai bot Mar 15, 2024

Choose a reason for hiding this comment

sourcery-ai bot Mar 15, 2024

Choose a reason for hiding this comment

sourcery-ai bot Mar 15, 2024

Choose a reason for hiding this comment

sourcery-ai bot Mar 15, 2024

Choose a reason for hiding this comment

sourcery-ai bot Mar 15, 2024

Choose a reason for hiding this comment

Before

After

sourcery-ai bot Mar 15, 2024

Choose a reason for hiding this comment

sourcery-ai bot Mar 15, 2024

Choose a reason for hiding this comment

codecov bot commented Mar 15, 2024 • edited Loading

Codecov Report

codecov bot commented Mar 15, 2024 •

edited

Loading