proffapt / iitkgp-erp-login-pypi Goto Github PK

Error handling is top-notch (maybe).

But error logging is not. Provide user friendly error logs on already handled possible cases of errors.

v2.3.0

This is a proven robust solution for CLI application. The current goal is to make it support WebApps' workflow without any Breaking chnages for CLI applications.

Idea

A default workflow of login in case of webapps integrated into the currently existing login() function.
Currently the workflow for webapps is broken into various steps through functions, basically like below:

What I want is a one liner to implement all of this from developer's perspective.
Break the workflow in 3-4 endpoints (as to-and-fro data passing is required). Implement those endpoints with proper error handling so that whichever frontend implements them can have proper logs.

Version

If done it will be v2.4.0.

Moving on from the basic iteration of just the workflow, integrating the specialities of CLI workflow into that of webapp will be wonderful.

• sessionToken & ssoToken storage and retrieval

Is your feature request related to a problem? Please describe.
The package is written in Python. That is a big problem.

Describe the solution you'd like
Rewrite in Rust

Describe alternatives you've considered
Any language, really.

• Implement Unit Tests
• Implement Integration Tests
• Trigger these tests on Pull Request using a pipeline

• There might be a time when OTP feature will be removed.
• Also, campus network doesn't require OTP login.

This way it will be universal login module

https://github.com/proffapt/iitkgp-erp-login-pypi/blob/5724f3d1e2d2a14955f799fa6793d74107f7b7d7/README.md?plain=1#L336 needs to be deleted :)

Also add sessionToken, ssoToken = to get the return values from erp.login. It is the only reason why this particular feature is not integrated into the login function itself. Just replace it with the text below:

import requests
import time

import erpcreds
# Importing erpcreds.py, which contains ERP credentials

import iitkgp_erp_login.erp as erp

headers = {
    'timeout': '20',
    'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/51.0.2704.79 Chrome/51.0.2704.79 Safari/537.36',
}
session = requests.Session()

print("Logging into ERP for:", creds.ROLL_NUMBER)

while True:
    if not erp.session_alive(session):
        _, ssoToken = erp.login(headers, session, ERPCREDS=erpcreds, LOGGING=True)
    else:
        print("Session is alive.")

    # Traverse ERP further using ssoToken

    time.sleep(2)

To Reproduce
Steps to reproduce the behavior:

1. Use open_erp.py
2. Logout ERP from browser
3. Use open_erp.py again
4. See error

Expected behavior
Either say it is valid or say it is not, and if it is something new then handle this case

Screenshots

Additional Context
Even if the session_valid() returns True in this case, the page says "The session is idle for too long time, re-login".

Correct the example used in this section.

This package utilises gmail api tokens, which get expired frequently and require manual intervention to refresh them which basically kills the whole point of automation. Fix it somehow, either using the documentation and implementing it correctly or use some other method.

Getting the following error, whenever I generate a new token.json:

Traceback (most recent call last):
  File "/opt/homebrew/lib/python3.11/site-packages/iitkgp_erp_login/erp.py", line 189, in login
    otp = getOTP(OTP_CHECK_INTERVAL)
          ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/lib/python3.11/site-packages/iitkgp_erp_login/read_mail.py", line 20, in getOTP
    creds = generate_token()
            ^^^^^^^^^^^^^^^^
  File "/opt/homebrew/lib/python3.11/site-packages/iitkgp_erp_login/utils.py", line 73, in generate_token
    creds.refresh(Request())
  File "/opt/homebrew/lib/python3.11/site-packages/google/oauth2/credentials.py", line 335, in refresh
    ) = reauth.refresh_grant(
        ^^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/lib/python3.11/site-packages/google/oauth2/reauth.py", line 351, in refresh_grant
    _client._handle_error_response(response_data, retryable_error)
  File "/opt/homebrew/lib/python3.11/site-packages/google/oauth2/_client.py", line 73, in _handle_error_response
    raise exceptions.RefreshError(
google.auth.exceptions.RefreshError: ('invalid_grant: Bad Request', {'error': 'invalid_grant', 'error_description': 'Bad Request'})

Describe the bug
Choosing to enter OTP manually does not trigger OTP request. OTP is only requested with Google OAuth enabled. This prevents users who choose to enter OTP manually from receiving the code.

To Reproduce
Log in without the use of Google OAuth Credentials

Expected behavior
OTP should be requested regardless of chosen OTP retrieval method (manual or Google OAuth).

Screenshots
NA

Desktop (please complete the following information):
This bug is not specific to a particular desktop environment.

Smartphone (please complete the following information):
This bug is not specific to a particular mobile device.

Additional context
NA