Skip to content

Cleanup task list and re-organize file structure #38271

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

Jump to bottom
Merged
chihsuan merged 7 commits into from
May 17, 2023
Merged

Cleanup task list and re-organize file structure #38271

chihsuan merged 7 commits into from
May 17, 2023

Conversation

@chihsuan
Copy link
Member

@chihsuan chihsuan commented May 12, 2023 •
edited
Loading

Submission Review Guidelines:

Changes proposed in this Pull Request:

While updating the task list document, I noticed that we have many outdated code that can be removed or deprecated, including task snooze APIs and old two-column experiment code.

Besides, we have three folders related to the task lists, which is very confusing. 😕

  • tasks: include task list entry file
  • task-lists: only contains progress title and header
  • two-column-tasks: It's acutally setup task list, not related to two-columns.

Thus, this PR makes the following changes:

  • Deprecate onboarding task snooze APIs c30d63c (snooze feature has been drepcated in Cleanup and deprecate task properties and methods #35450)
  • Removes the remaining two-column experiment code in the task list (in both backend and frontend)
  • Re-organizes task list file structure:
    • Merge ./client/tasks folder into ./client/task-lists To express what it actually is.
    • Rename two-column-tasks to setup-task-list and also move it into ./client/task-lists folder
    • Update the corresponding component names and import paths
    • Moves components to ./task-lists/components folder

After merging this, we can find all frontend task list files in ./client/task-lists/ directory.

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

  1. Install and activate WooCommerce in a brand new site
  2. Go to WooCommerce > Home
  3. Confirm the task lists are shown as expected as previous
  4. Perform a smoke test on the task list
  5. Complete set up a task list
  6. Observe that task list completion UI is shown

@github-actions github-actions bot added focus: react admin [team:Ghidorah] plugin: woocommerce Issues related to the WooCommerce Core plugin. labels May 12, 2023
@chihsuan chihsuan marked this pull request as ready for review May 12, 2023 08:11
@chihsuan chihsuan requested review from a team, adrianduffell and moon0326 May 12, 2023 08:16
@github-actions
Copy link
Contributor

github-actions bot commented May 12, 2023

Hi @moon0326, @adrianduffell, @woocommerce/ghidorah

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

@chihsuan chihsuan self-assigned this May 12, 2023
@github-actions
Copy link
Contributor

github-actions bot commented May 12, 2023 •
edited
Loading

Test Results Summary

Commit SHA: 81fcbee

Test 🧪Passed ✅Failed 🚨Broken 🚧Skipped ⏭️Unknown ❔Total 📊Duration ⏱️
API Tests26700202690m 51s
E2E Tests1890010019918m 28s
To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

@codecov
Copy link

codecov bot commented May 12, 2023 •
edited
Loading

Codecov Report

Merging #38271 (81fcbee) into trunk (8c7fa2e) will increase coverage by 0.3%.
The diff coverage is 100.0%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             trunk   #38271     +/-   ##
==========================================
+ Coverage     51.2%    51.5%   +0.3%     
- Complexity   17439    17443      +4     
==========================================
  Files          440      440             
  Lines        80722    80290    -432     
==========================================
  Hits         41348    41348             
+ Misses       39374    38942    -432
Impacted Files Coverage Δ
plugins/woocommerce/includes/wc-core-functions.php 63.6% <100.0%> (ø)

... and 5 files with indirect coverage changes

moon0326
moon0326 approved these changes May 16, 2023
View reviewed changes
Copy link
Contributor

@moon0326 moon0326 left a comment

Choose a reason for hiding this comment

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

Thank you for working on it 👍

LGTM and everything worked as expected on WooCommerce Home 🚀

adrianduffell
adrianduffell approved these changes May 16, 2023
View reviewed changes
Copy link
Contributor

@adrianduffell adrianduffell left a comment

Choose a reason for hiding this comment

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

Tested well and the new folder layout is much nicer. Love to see a negative code line diff in a PR! 🚀

@chihsuan chihsuan merged commit dcbfbe2 into trunk May 17, 2023
@chihsuan chihsuan deleted the dev/clean-up-task-list branch May 17, 2023 01:54
@github-actions github-actions bot added this to the 7.8.0 milestone May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@moon0326 moon0326 moon0326 approved these changes

@adrianduffell adrianduffell adrianduffell approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@chihsuan chihsuan

Labels

plugin: woocommerce Issues related to the WooCommerce Core plugin.

Projects

None yet

Milestone

7.8.0

Development

Successfully merging this pull request may close these issues.

4 participants

@chihsuan @moon0326 @adrianduffell