FC-86 feat: Empty page templates by vladislavkeblysh · Pull Request #3 · openedx/frontend-app-catalog

vladislavkeblysh · 2025-05-22T08:32:36Z

Note

This pull request depends on that PR.

Description

Added empty page templates:

Added template for Home page
Added template for Catalog page
Added template for Course About page
Aded routing
Updated setup.js

How Has This Been Tested?

Clone this repository
Check that Home page is displaying on "/" route
Check that Catalog page is displaying on "/courses" route
Check that Course About page is displaying on "/courses/:courseId/about" route

openedx-webhooks · 2025-05-22T08:32:41Z

Thanks for the pull request, @vladislavkeblysh!

This repository is currently maintained by @openedx/committers-frontend.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

codecov · 2025-05-22T08:34:54Z

Codecov Report

Attention: Patch coverage is 60.00000% with 6 lines in your changes missing coverage. Please review.

Project coverage is 24.32%. Comparing base (b16b5fb) to head (f39ac73).
Report is 2 commits behind head on master.

Files with missing lines	Patch %	Lines
src/index.tsx	0.00%	6 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           master       #3       +/-   ##
===========================================
+ Coverage    0.00%   24.32%   +24.32%     
===========================================
  Files           3        6        +3     
  Lines          24       37       +13     
===========================================
+ Hits            0        9        +9     
- Misses         24       28        +4

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

peterkulko

After merging dependent PRs, LGTM!

diana-villalvazo-wgu · 2025-05-23T21:42:58Z

Hi @vladislavkeblysh can you rebase master branch? thanks 😄

peterkulko

LGPM!

brian-smith-tcril

Would you be able to break this PR up into the empty page templates and the "not found" page.

I'm happy to review the empty templates as placeholders, but this PR includes what appears to be a mostly final version of the "not found" page.

I'm more or less happy to merge the templates as they are in this PR, and I don't want my comments on the "not found" page to block that.

brian-smith-tcril · 2025-05-27T14:09:37Z

+              <Route path="/" element={<HomePage />} />
+              <Route path="/courses" element={<CatalogPage />} />
+              <Route path="/courses/:courseId/about" element={<CourseAboutPage />} />
+              <Route path="*" element={<NotFoundPage />} />


I bet if we add some tests to verify the correct pages are rendered at the correct routes almost all of the Codecov "not covered by tests" warnings will disappear.

brian-smith-tcril · 2025-05-27T14:25:12Z

@@ -0,0 +1,3 @@
+.not-found-message {
+    max-width: 32em;


I'm curious about the hardcoded 32em here. From what I can tell it is being used to create a newline between "The page you're looking for is unavailable or there's an error in the URL." and "Please check the URL and try again."

This works for English, but I don't think it provides the intended result in other languages.

Using https://github.com/openedx/openedx-translations/blob/13bd491a2fffd1a39d3a8fdd33739b969000d059/translations/frontend-app-profile/src/i18n/messages/vi.json#L7 as an example

Not found page component moved in separate PR

sarina · 2025-05-28T16:34:43Z

Please remember to put the FC number (FC-86) in the title of the PRs, thank you!

brian-smith-tcril · 2025-05-30T15:53:59Z

+
+  return (
+    <Container size="sm">
+      <p className="my-0 py-5 text-muted text-center not-found-message mx-auto">


This class doesn't exist now that NotFoundPage.scss was removed in https://github.com/openedx/frontend-app-catalog/compare/a7c8e0155c756d33555f4655f3e24ba15ab88d64..46017bd5b0a2e8a0df64132aa38ee9d6d958cdd3

Suggested change

<p className="my-0 py-5 text-muted text-center not-found-message mx-auto">

<p className="my-0 py-5 text-muted text-center mx-auto">

Not found page component moved in separate PR

peterkulko · 2025-05-30T07:25:25Z

+  };
+});
+
+jest.mock('@edx/frontend-component-header', () => function () {


Can we get rid of this warning?

peterkulko · 2025-05-30T07:26:34Z

+jest.mock('@edx/frontend-component-header', () => function () {
+  return <header>Header</header>;
+});
+jest.mock('@edx/frontend-component-footer', () => ({


Please add some spacing between these lines jest.mocks

brian-smith-tcril

Overall this looks great!

One small comment about tests but other than that this is looking ready to merge!

brian-smith-tcril · 2025-06-02T13:13:28Z

+  it('renders HomePage at route /', () => {
+    const { getByText } = renderWithProviders('/');
+
+    expect(getByText('Home page')).toBeInTheDocument();


While this will work for now, it will need to be updated as soon as the placeholder <h1>Home page</h1> is removed from the HomePage component. Would switching to checking for a test id here make more sense?

vladislavkeblysh self-assigned this May 22, 2025

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 22, 2025

openedx-webhooks added this to Contributions May 22, 2025

github-project-automation Bot moved this to Needs Triage in Contributions May 22, 2025

vladislavkeblysh requested review from brian-smith-tcril, ihor-romaniuk and peterkulko May 22, 2025 08:32

vladislavkeblysh force-pushed the keblysh/feat/empty-page-templates branch from 0e38e4d to f31e1e6 Compare May 22, 2025 08:41

peterkulko approved these changes May 22, 2025

View reviewed changes

vladislavkeblysh requested review from diana-villalvazo-wgu and peterkulko May 26, 2025 09:05

vladislavkeblysh force-pushed the keblysh/feat/empty-page-templates branch from 3d2dc4d to f31e1e6 Compare May 26, 2025 09:11

feat: add empty page templates

c8dc06b

vladislavkeblysh force-pushed the keblysh/feat/empty-page-templates branch from f31e1e6 to c8dc06b Compare May 26, 2025 09:32

vladislavkeblysh removed the request for review from ihor-romaniuk May 26, 2025 09:32

peterkulko approved these changes May 26, 2025

View reviewed changes

diana-villalvazo-wgu approved these changes May 26, 2025

View reviewed changes

brian-smith-tcril reviewed May 27, 2025

View reviewed changes

mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions May 27, 2025

sarina changed the title ~~feat: Empty page templates~~ FC-86 feat: Empty page templates May 28, 2025

feat: update test

46017bd

vladislavkeblysh force-pushed the keblysh/feat/empty-page-templates branch from a7c8e01 to 46017bd Compare May 30, 2025 06:41

brian-smith-tcril reviewed May 30, 2025

View reviewed changes

feat: refactor after review

1ed63c6

vladislavkeblysh mentioned this pull request Jun 1, 2025

feat: [FC-86] Not found page and routing refactoring #4

Merged

peterkulko suggested changes Jun 2, 2025

View reviewed changes

feat: refactor after review

6c0f09d

peterkulko approved these changes Jun 2, 2025

View reviewed changes

brian-smith-tcril reviewed Jun 2, 2025

View reviewed changes

feat: refactor after review

f39ac73

brian-smith-tcril approved these changes Jun 3, 2025

View reviewed changes

brian-smith-tcril merged commit b1a42de into openedx:master Jun 3, 2025

github-project-automation Bot moved this from In Eng Review to Done in Contributions Jun 3, 2025

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Jun 20, 2025

	<p className="my-0 py-5 text-muted text-center not-found-message mx-auto">
	<p className="my-0 py-5 text-muted text-center mx-auto">

Uh oh!

Conversation

vladislavkeblysh commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How Has This Been Tested?

Uh oh!

openedx-webhooks commented May 22, 2025

Uh oh!

codecov Bot commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

peterkulko left a comment

Choose a reason for hiding this comment

Uh oh!

diana-villalvazo-wgu commented May 23, 2025

Uh oh!

peterkulko left a comment

Choose a reason for hiding this comment

Uh oh!

brian-smith-tcril left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vladislavkeblysh Jun 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sarina commented May 28, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vladislavkeblysh Jun 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brian-smith-tcril left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

vladislavkeblysh commented May 22, 2025 •

edited

Loading

codecov Bot commented May 22, 2025 •

edited

Loading

vladislavkeblysh Jun 1, 2025 •

edited

Loading

vladislavkeblysh Jun 1, 2025 •

edited

Loading