Skip to content
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.

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

New release for version 3.5.0 #1209

Merged
merged 23 commits into from
Sep 30, 2023
Merged

New release for version 3.5.0 #1209

merged 23 commits into from
Sep 30, 2023

Conversation

chunweii
Copy link
Contributor

Summary:

New release

Proposed Commit Message:

Merge master into release to release V3.5.0

Refactor and remove uses of Electron from CATcher

There are many uses of Electron in CATcher, even with the CATcher Electron
app being deprecated.  As such, there are many instances of unused code,
which is bad practice. Removing instances of uses of Electron allows us to
trim the codebase and remove dead code.

Let's 
* Refactor and remove uses of Electron from CATcher
* Remove all uses of Electron in the `src` folder first.
* Remove uses of Electron from `package.json` and other files
* Delete folders such as `electron-utils` and files such as `postinstall` that
are used to initialise electron
* Remove and amend scripts in `package.json` that are involved in
building the electron app
* Edit `deployment-actions.yml` to remove pre-build actions from CD
workflow
Add Release-drafter bot to repository 

Release notes are currently updated manually by developers after 
creating a release. 

Adding Release-drafter bot can automate this process. 

Let's create a configuration file for Release-drafter bot so it can 
update & categorize changelog every time  PR gets merged.
Checkboxes are not longer being rendered due to the sanitizer sanitizing html input tags

However, removing the sanitizer could be unsafe

Let's
* Fixes checkboxes being sanitized when rendered in markdown
* Replace checkbox rendering via the use of emojis 
* Addition of fontawesome icon library to standardize emoji font face

---------

Co-authored-by: Kang Su Min <66008784+kkangs0226@users.noreply.github.com>
Invalid tooltips from being displayed due to unintended binding of title attribute

Let's 
* Avoid the issue by renaming title to descriptionTitle
Add tooltip to markdown toolbar

Currently tooltips bar does not have a tooltip when hovered upon.
This can cause confusion in finding out what the buttons do.

Let's add custom tooltips to the buttons in the toolbar.
Keyboard hotkeys like bold and italics breaks when Caps lock is turned on.

Let's
* Change checking of keys from using KeyboardEvent.key to use KeyboardEvent.code
* Adds additional check to ensure Shift key is not pressed when executing these hotkeys
Undo and redo history breaks upon actions that edit the text area 
programmatically such as pasting in an image

Let's
* Replace the undo redo in text area with a custom version
* Prevents the resetting of undo and redo
…isted (#1172)

Add spinners to indicate if edited information in issue has been persisted.

Currently, there are not many indications on whether edited changes to an issue have been successful.

A user has to guess after submitting his/her changes on whether the edited changes have been persisted.

Adding spinners to indicate if this has been successful will allow for better and more interactive UI/UX

Let's
* Add a Loading Service that abstracts the logic of whether a particular component has pending changes made
* Loading Service can help future devs to build their spinners and appropriately add them
* Add spinners on buttons which are in charge of submitting the information 
* Add unit tests to ensure functionality of LoadingService
* Add unit tests for implemented methods in TitleComponent, DescriptionComponent and LabelComponent
Inefficient nesting of subscribers in IssueDataTable has introduced 
unnecessary and very expensive computes to CATcher.

Let's 
- Improve CATcher's efficiency by removing the nesting of subscribers
in IssueDataTable.ts
Migrate Login page e2e test to Playwright

Let's
- Initialize Playwright config files
- Add Playwright workflow
- Migrate Protractor's `login.e2e-spec.ts` to Playwright's `login.spec.ts`
Let's
- Migrate `bugReportingPhase.e2e-spec.ts` to Playwright's 
`bugReportingPhase.spec.ts`
- Remove protractor from CATcher
Clean up playwright migration

There are some leftover tasks to complete the e2e migration.

Let's remove the extraneous login.spec.ts file, as well as webdriver 
from package.json
Let's bump some of our libraries to a more updated version to resolve 
missing peer dependencies.
"Mention a user" and "Reference an issue, pull request or discussion"
buttons in the markdown toolbar do not provide significant benefits in
the context of a PE due to the lack of functionality and intended
anonymity in the PE environment.

Removing these buttons avoids any potential confusion among users
arising from the lack of support for these buttons.

Let's avoid any confusion by removing these buttons from the markdown
toolbar.
Let's specify node to package.json to throw error if node version is not 14.
Fix comment-editor.component tests

Async tests in `comment-editor.component.spec.ts` never fail even when
written to intentionally fail.

Let's fix the tests so that they fail when they should.
Fix title being cut off in issue-tables

Let's
* Replace the truncation of text by JavaScript with CSS instead.
* Reduces reliance on pre-determined `MAX_WORD_LENGTH`.
Extract isUndo, isRedo into UndoRedo model
Add attribute directive to mat-paginator

The selected items per page setting for each issue table is lost 
after navigation to a different page or on refresh.

Caching this setting is more user-friendly because users do 
not need to re-input the same page settings.

Let's save this setting to session storage using an attribute directive.
Vertically center titles of timeline-header class

The text within the css class timeline-header is not vertically
centralized.

Let's:
- Add styles to timeline-header class in styles.css and 
  parse-error.component.css
- Remove inline styling from the span of the following 
  components:
  - issue-dispute.component
  - new-team-response.component
  - tester-response.component
Upgrade to Angular 11

Some of our packages are old and outdated. We should actively maintain 
and keep these packages up-to-date so it is easier to maintain in the 
future.

Let's upgrade to Angular 11 to keep our packages up-to-date.
@codecov-commenter
Copy link

Codecov Report

Attention: 90 lines in your changes are missing coverage. Please review.

Comparison is base (107af02) 53.42% compared to head (a58e608) 53.93%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@             Coverage Diff             @@
##           release    #1209      +/-   ##
===========================================
+ Coverage    53.42%   53.93%   +0.51%     
===========================================
  Files          100      101       +1     
  Lines         2727     2881     +154     
  Branches       512      534      +22     
===========================================
+ Hits          1457     1554      +97     
- Misses         931      984      +53     
- Partials       339      343       +4     
Files Coverage Δ
src/app/core/services/auth.service.ts 13.69% <100.00%> (+0.54%) ⬆️
src/app/core/services/issue.service.ts 8.37% <ø> (-0.48%) ⬇️
src/app/core/services/logging.service.ts 66.03% <100.00%> (+2.40%) ⬆️
.../app/shared/issue-tables/issue-tables.component.ts 14.13% <ø> (-23.25%) ⬇️
src/app/shared/lib/marked.ts 87.50% <100.00%> (-12.50%) ⬇️
src/app/core/services/github.service.ts 15.60% <0.00%> (-0.60%) ⬇️
src/app/shared/issue/title/title.component.ts 76.92% <77.77%> (+1.36%) ⬆️
.../shared/issue/description/description.component.ts 79.41% <81.25%> (+2.36%) ⬆️
src/app/shared/issue/label/label.component.ts 74.41% <81.25%> (+3.83%) ⬆️
src/app/shared/issue-tables/IssuesDataTable.ts 0.00% <0.00%> (ø)
... and 3 more

... and 1 file with indirect coverage changes

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

@chunweii chunweii merged commit 6adb0b2 into release Sep 30, 2023
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants