Skip to content

[AU-2523] codespaces devstack collision port 2000 for frontend-app-learning #150

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

[AU-2523] codespaces devstack collision port 2000 for frontend-app-learning #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0401bf2
fix: update frontend-app-learning port from 2000 to 2010 across confi…
papphelix Jun 3, 2025
34affdf
fix: update CSRF_TRUSTED_ORIGINS to use port 2010 for frontend-app-le…
papphelix Jun 3, 2025
a6e34c1
fix: update frontend-app-learning port from 2000 to 2010 to resolve C…
papphelix Jun 5, 2025
069f4c3
Removing redundant comments
papphelix Jun 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@
"postCreateCommand": ".devcontainer/postCreateCommand.sh",
"postStartCommand": ".devcontainer/postStartCommand.sh",
"forwardPorts": [
1976, 1984, 1990, 1991, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
2001, 3001, 3406, 5335, 7474, 8000, 8081, 8734, 8735, 9021, 9201, 9202,
1976, 1984, 1990, 1991, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2001,
2010, 3001, 3406, 5335, 7474, 8000, 8081, 8734, 8735, 9021, 9201, 9202,
9301, 9600, 18000, 18010, 18040, 18110, 18120, 18130, 18150, 18160,
18170, 18270, 18280, 18381, 18400, 18450, 18734, 18760, 18787, 19001,
27017, 44567
Expand All @@ -60,7 +60,7 @@
"18130": { "label": "ecommerce" },
"18150": { "label": "credentials" },
"18120": { "label": "edx_notes_api" },
"2000": { "label": "frontend-app-learning" },
"2010": { "label": "frontend-app-learning" },
"1998": { "label": "frontend-app-payment" },
"18400": { "label": "frontend-app-publisher" },
"1994": { "label": "frontend-app-gradebook" },
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1103,7 +1103,7 @@ services:
aliases:
- edx.devstack.frontend-app-learning
ports:
- "2000:2000"
- "2010:2000" # avoid Codespaces port 2000 conflict
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this comment and the notes in the rst doc are probably enough. I do not think we need to document this conflict for every usage of http://localhost:2010. We'll get an additional opinion before deciding either way, but it will be important to decide before making changes across repos.

depends_on:
- lms

Expand Down
5 changes: 4 additions & 1 deletion docs/service_list.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Instead of a service name or list, you can also run commands like ``make dev.pro
+------------------------------------+-------------------------------------+----------------+--------------+
| `frontend-app-learner-record`_ | http://localhost:1990/ | MFE (React.js) | Default |
+------------------------------------+-------------------------------------+----------------+--------------+
| `frontend-app-learning`_ | http://localhost:2000/ | MFE (React.js) | Default |
| `frontend-app-learning`_ | http://localhost:2010/ | MFE (React.js) | Default |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we want a row with "Do not use. Reserved for Codespaces.", and http://localhost:2000/, to help ensure this doesn't happen again in the future.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a row in rst table and added explanation on the same

+------------------------------------+-------------------------------------+----------------+--------------+
| `frontend-app-payment`_ | http://localhost:1998/ | MFE (React.js) | Default |
+------------------------------------+-------------------------------------+----------------+--------------+
Expand Down Expand Up @@ -75,12 +75,15 @@ Instead of a service name or list, you can also run commands like ``make dev.pro
+------------------------------------+-------------------------------------+----------------+--------------+
| `enterprise-subsidy`_ | http://localhost:18280 | Python/Django | Extra |
+------------------------------------+-------------------------------------+----------------+--------------+
| **Reserved for Codespace** | http://localhost:2000 | **Codespace** | Default |
+------------------------------------+-------------------------------------+----------------+--------------+

Some common service combinations include:

* ``lms``: LMS, along with dependencies ``forum``, ``discovery``, ``Authn`` and some databases
* ``ecommerce``: Ecommerce, but also LMS as a dependency (for auth)
* ``cms+credentials``: Services can be combined to affect both at once
* **Reserved for Codespace**: The port `2000` is being used for github Codespace service & reserverd for Codespace use only.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **Reserved for Codespace**: The port `2000` is being used for github Codespace service & reserverd for Codespace use only.
* **Reserved for Codespace**: The port `2000` is being used for github Codespace service & reserved for Codespace use only.


.. _credentials: https://github.com/openedx/credentials
.. _discovery: https://github.com/openedx/course-discovery
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshoot_general_tips.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ Update as of 2023-08-03: The issue was moved to https://2u-internal.atlassian.ne

CORS error from login_refresh in MFE
------------------------------------
If you see "Access to XMLHttpRequest at 'http://localhost:18000/login_refresh' from origin 'http://localhost:2000' has been blocked by CORS policy: Request header field x-xsrf-token is not allowed by Access-Control-Allow-Headers in preflight response" it usually means you don't have a valid session.
If you see "Access to XMLHttpRequest at 'http://localhost:18000/login_refresh' from origin 'http://localhost:2010' has been blocked by CORS policy: Request header field x-xsrf-token is not allowed by Access-Control-Allow-Headers in preflight response" it usually means you don't have a valid session.

The fix is to get a new auth session. You can do any of the following:

Expand Down
2 changes: 1 addition & 1 deletion py_configuration_files/course_discovery.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
'http://localhost:1991', # frontend-app-admin-portal
'http://localhost:18400', # frontend-app-publisher
'http://localhost:18450', # frontend-app-support-tools
'http://localhost:2000', # frontend-app-learning
'http://localhost:2010', # frontend-app-learning
)

ELASTICSEARCH_DSL['default']['hosts'] = 'edx.devstack.elasticsearch710:9200'
Expand Down
2 changes: 1 addition & 1 deletion py_configuration_files/ecommerce.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
'http://localhost:1996',
'http://localhost:1997', # Account MFE
'http://localhost:1998',
'http://localhost:2000', # Learning MFE
'http://localhost:2010', # Learning MFE
'http://localhost:8734', # Enterprise Learner Portal MFE
)
CORS_ALLOW_HEADERS = corsheaders_default_headers + (
Expand Down
2 changes: 1 addition & 1 deletion py_configuration_files/enterprise_subsidy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
LMS_URL = 'http://edx.devstack.lms:18000'
ENTERPRISE_CATALOG_URL = 'http://edx.devstack.enterprise-catalog:18160'
ENTERPRISE_SUBSIDY_URL = 'http://localhost:18280'
FRONTEND_APP_LEARNING_URL = 'http://localhost:2000'
FRONTEND_APP_LEARNING_URL = 'http://localhost:2010' # Learning MFE

# Kafka Settings
# "Standard" Kafka settings as defined in https://github.com/openedx/event-bus-kafka/tree/main
Expand Down
6 changes: 3 additions & 3 deletions py_configuration_files/lms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing
'localhost:1997', # frontend-app-account
'localhost:1976', # frontend-app-program-console
'localhost:1994', # frontend-app-gradebook
'localhost:2000', # frontend-app-learning
'localhost:2010', # frontend-app-learning (port changed from 2000 to 2010, due to conflict in codepsace)
'localhost:2001', # frontend-app-course-authoring
'localhost:3001', # frontend-app-library-authoring
'localhost:18400', # frontend-app-publisher
Expand Down Expand Up @@ -382,7 +382,7 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing
EDXNOTES_CLIENT_NAME = 'edx_notes_api-backend-service'

############## Settings for Microfrontends #########################
LEARNING_MICROFRONTEND_URL = 'http://localhost:2000'
LEARNING_MICROFRONTEND_URL = 'http://localhost:2010'
ACCOUNT_MICROFRONTEND_URL = 'http://localhost:1997'
PROFILE_MICROFRONTEND_URL = 'http://localhost:1995'
COMMUNICATIONS_MICROFRONTEND_URL = 'http://localhost:1984'
Expand Down Expand Up @@ -542,7 +542,7 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing

# MFEs that will call this service in devstack
CSRF_TRUSTED_ORIGINS = [
'http://localhost:2000', # frontend-app-learning
'http://localhost:2010', # frontend-app-learning
'http://localhost:2001', # frontend-app-course-authoring
'http://localhost:1997', # frontend-app-account
'http://localhost:1995', # frontend-app-profile
Expand Down
Loading