lrivallain / azure_docs_watcher

Watch changes in the Azure docs repositories

Hi there 👋

• My resume: https://ludovic.rivallain.fr
• Blog: https://vuptime.io/

azure_docs_watcher's Issues

Feature: Add caching for home page and maybe for commits

Problem description

Response time of the home page is quite bad:

Even worst for commit pages.

Describe the solution you'd like

Implement an in-memory cache to store home page data and maybe commits data for period of time.

Additional context

n/a

Feature: Add about and report issue links

Problem description

If user encounters an error, he cannot easily report an issue.

Describe the solution you'd like

A dropdown navigation menu with about and report issue links.

Feature: Add AzureSQL docs (and other projects)

Problem description

Azure SQL docs are managed in another repository: https://github.com/MicrosoftDocs/sql-docs/tree/live/azure-sql and not following the /articles nomenclature from global Azure docs repository.

Some other projects like Azure Quantum (preview) are also manage in a specific repository.

Describe the solution you'd like

Add, through configuration, other repositories.

Change home page to enable browsing repositories based on configured projects.

Additional context

Will require a breaking URL change probably.

Issue: Error when using a github login with organization saml enforcement policy need-ing a refresh

Description

When using a GitHub account linked to an organization with saml enforcement policy: if the saml enforcement is expired, an error is displayed.

To Reproduce

See logs:

2022-11-04T12:58:24.397426356Z: [ERROR]  2022-11-04 12:58:24 bc5621157392 app[80] ERROR 403 {"message": "Resource protected by organization SAML enforcement. You must grant your OAuth token access to this organization.", "documentation_url": "https://docs.github.com/articles/authenticating-to-a-github-organization-with-saml-single-sign-on/"}

Expected behavior

List of sections or commits.

Screenshots

n/a

Additional context

n/a

Feature: Dark mode for real devs

Problem description

Dark mode for real devs

Describe the solution you'd like

Provide a Dark mode for people using a dark scheme OS/app + provide a switch to toogle the theme.

Issue: favicon RSS feed

Description

Without having specified an icon for the RSS feed, the parser are trying to get /favicon.ico and generate 404 errors.

To Reproduce

Open network console of a browser, open an RSS feed and watch for 404 errors.

Expected behavior

No 404 is generated.

Screenshots

n/a

Additional context

n/a

Feature: Provide a way to specify the number of days to check in the past for authenticated users

Problem description

Even when authenticated, a user can only see commits for the last 5 days, but may need more.

Describe the solution you'd like

A form could be available to provide a new number of days to look back for.

If possible, hidden in a place where it do not take too much place.

! Only for authenticated users.

Additional context

n/a

Feature: custom repositories support

Problem description

A user cannot keep track of changes in a not configured repository.

Describe the solution you'd like

Support custom repositories, based on their owner/name.

Additional context

Will need a redraw of url mapping.

Issue: When logging user is redirected to home page

Description

When logging user is redirected to home page

To Reproduce

Login

Expected behavior

User is logged and redirected to the page he was visiting earlier.

Screenshots

n/a

Additional context

n/a

Issue: Error while listing commits - ERROR 'NoneType' object has no attribute 'name'

Description

Visit https://azdocswatch.vupti.me/articles/virtual-machines result in an error HTTP500: Error while listing commits.

To Reproduce

Steps to reproduce the behavior:

1. Go to https://azdocswatch.vupti.me/articles/virtual-machines
2. See error

In logs:

ERROR 'NoneType' object has no attribute 'name'

Expected behavior

List of commits is displayed

Screenshots

n/a

Additional context

n/a

Feature: RSS feed

Problem description

Monitor a section of Azure Docs repository requires to visit azure doc watcher site.

Describe the solution you'd like

Provide a RSS feed of the X last changes of a specific section of the Azure Docs repository.

Additional context

Could introduce more details in the feed data like the content of the change.

Feature: API endpoints

Problem description

Only HTML or RSS outputs are available now.

Describe the solution you'd like

Provide json based output on a specific API endpoint.

Additional context

n/a

Issue: Error while listing commits after authentication

Description

Listing commits from a section after a successful authentication results in an error: Error while listing commits.

To Reproduce

Steps to reproduce the behavior:

1. Go to https://azdocswatch.vupti.me
2. Login
3. Go to https://azdocswatch.vupti.me/articles/active-directory-b2c
4. See error

In logs:

2022-11-03T10:03:58.818046513Z: [ERROR]  2022-11-03 10:03:58 63eb4a256818 app[80] ERROR '>' not supported between instances of 'int' and 'str'
2022-11-03T10:03:58.836790358Z: [INFO]  82.65.43.153:55505 - - [03/Nov/2022:10:03:58 +0000] "GET /articles/active-directory-b2c HTTP/1.1" 500 27 "https://azdocswatch.vupti.me/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:105.0) Gecko/20100101 Firefox/105.0"

Expected behavior

List of last commits.

Screenshots

n/a

Additional context

n/A

Issue: Login with GitHub is not working on production deploiment

Description

Trying to login after the deployment of the GH login feature on production results on a redirect (with no authentication) to the / index page.

Logs:

2022-11-03T09:47:23.299589990Z: [INFO]  169.254.131.1 - - [03/Nov/2022:09:47:23 +0000] "GET /login HTTP/1.1" 302 213 "https://azdocswatch.vupti.me/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:105.0) Gecko/20100101 Firefox/105.0"
2022-11-03T09:47:23.521157373Z: [INFO]  169.254.131.1 - - [03/Nov/2022:09:47:23 +0000] "GET /login/github HTTP/1.1" 302 619 "https://azdocswatch.vupti.me/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:105.0) Gecko/20100101 Firefox/105.0"
2022-11-03T09:47:23.854066550Z: [ERROR]  2022-11-03 09:47:23 3657adc80225 flask_dance.consumer.oauth2[80] WARNING OAuth 2 authorization error: redirect_uri_mismatch description: The redirect_uri MUST match the registered callback URL for this application. uri: https://docs.github.com/apps/managing-oauth-apps/troubleshooting-authorization-request-errors/#redirect-uri-mismatch
2022-11-03T09:47:23.856855060Z: [INFO]  169.254.131.1 - - [03/Nov/2022:09:47:23 +0000] "GET /login/github/authorized?error=redirect_uri_mismatch&error_description=The+redirect_uri+MUST+match+the+registered+callback+URL+for+this+application.&error_uri=https%3A%2F%2Fdocs.github.com%2Fapps%2Fmanaging-oauth-apps%2Ftroubleshooting-authorization-request-errors%2F%23redirect-uri-mismatch&state=fMYZKryl5aFjLRftT67S8OyBy9KuNg HTTP/1.1" 302 189 "https://azdocswatch.vupti.me/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:105.0) Gecko/20100101 Firefox/105.0"
2022-11-03T09:47:24.687916799Z: [INFO]  169.254.131.1 - - [03/Nov/2022:09:47:24 +0000] "GET / HTTP/1.1" 200 101193 "https://azdocswatch.vupti.me/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:105.0) Gecko/20100101 Firefox/105.0"

To Reproduce

Steps to reproduce the behavior:

1. Go to home page
2. Click on Login
3. You are directly redirected to home page: no login prompt.

Expected behavior

User is redirected to GH oAuth2 login page for the current application.

Screenshots

n/a

Additional context

n/a