chore: migrate to symfony/mailer by DeepDiver1975 · Pull Request #41009 · owncloud/core

DeepDiver1975 · 2023-10-04T15:04:37Z

Description

Related Issue

Fixes Swiftmailer has reached EOL in Nov '21 #40564

QA Scenarios

Scenarios

try to send mail from admin section
send invite via CalDAV

Mail Setups to test

send mail
qmail
smtp with ssl
smtp without ssl

How Has This Been Tested?

test environment:
test case 1:
test case 2:
...

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Database schema changes (next release will require increase of minor version instead of patch)
Breaking change (fix or feature that would cause existing functionality to change)
Technical debt
Tests only (no source changes)

Checklist:

update-docs · 2023-10-04T15:04:41Z

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

DeepDiver1975 · 2023-10-05T10:56:04Z

@mmattel we have dropped one config setting - also the admin ui looks a bit different now .....
In addition the smtp encryption option is now either 'ssl/tls' or 'none' .... 'STARTTLS' has been dropped

config/config.sample.php

mmattel · 2023-10-05T12:05:24Z

smtp encryption option is now either 'ssl/tls' or 'none' .... 'STARTTLS' has been dropped

Same as written in the code comment above, this is a release notes thing and needs mentioning there --> @pako81

mmattel · 2023-10-05T12:10:25Z

the admin ui looks a bit different now

Can one drop me a screenshot we can use for docs into: owncloud/docs-server#1137 ? and clarify for which version this change is targeted?

@pako81 @jnweiger fyi

DeepDiver1975 · 2023-10-05T13:41:50Z

@individual-it @phil-davis can I ask you for a quick look - THX a lot:

individual-it · 2023-10-06T03:50:13Z

The failing case is that sendmail is set as the mode but no sendmail is installed/configured on the system (/usr/sbin/sendmail -bs).
Looks like the exception is thrown but does not cause occ to return 1 as exit code

lib/private/Mail/Mailer.php

sonarqubecloud · 2023-10-06T11:10:49Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
1 Security Hotspot
2 Code Smells

74.5% Coverage
0.0% Duplication

phil-davis

Looks good, and tests all pass.
I made a few notes mainly about backward-compatibility. The way the ownCloud Mailer etc classes are currently structured, they expose parts of SwiftMailer, so to get rid of SwiftMailer there have to be changes to public method interfaces.
What do we do about that for oC core major version 10 with PHP 7.4?

(for PHP 8.2 it is easier - we would bump the major version of oC core to 11)

composer.phar

phil-davis · 2023-10-09T02:02:47Z

settings/Controller/MailSettingsController.php

 		$mail_smtpmode,
 		$mail_smtpsecure,
 		$mail_smtphost,
-		$mail_smtpauthtype,


what do we do about things like this?
In apps that we manage, and that happen to call setMailSettings, we can adjust the app and coordinate the release.
For "unknown" apps, this would be a BC break.
Or am I thinking wrong?

phil-davis · 2023-10-09T02:52:38Z

lib/private/Mail/Mailer.php

 		]);

-		return $failedRecipients;
+		return [];


Are we keeping the "return array" behavior for backward compatibility?
This method now always either:

returns an empty array; or

throws an exception

So it could just "return void", indicating success. But maybe there are other callers that are expecting the old behavior, and think that success is indicated by an empty array returned.

lib/private/Mail/Message.php

phil-davis · 2023-10-09T02:59:08Z

lib/private/Mail/Message.php

-	 */
-	public function getSwiftMessage() {
-		return $this->swiftMessage;
+	public function getMessage(): Email {


and the method name changes here - so definitely not backward-compatible.

Due to this the original design did not have an iMessage.
Never the less: yes - this breaks API.

phil-davis · 2023-10-09T06:15:05Z

This can wait for merge until release-10.13.2 is out of the way, so we have time to discuss what happens for releases after doing this change for the PHP 7.4 code base - will it be "the usual" 10.14.0 minor version bump, and we work out how to address backward-compatibility issues (for example, that any real backward-compatibility issues can be handled OK for any apps that are affected).

Or would this cause a major version bump, forcing an 11.0.0 release that supports PHP 7.4...

DeepDiver1975 · 2023-10-09T07:12:37Z

From my understanding oc11 is php8.2
We can also merge this or into the php8.2 pr

…ected

…uring delivery

sonarqubecloud · 2023-11-13T22:54:11Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
1 Security Hotspot
2 Code Smells

74.5% Coverage
0.0% Duplication

phil-davis · 2024-02-05T11:47:13Z

I suppose this is blocked/stalled for now. Can't easily be part of 10.14 because of backward-compatibility issues that are not easily avoided.

DeepDiver1975 · 2024-02-05T11:49:38Z

I planned to do this as part of #40981 🤷

DeepDiver1975 · 2024-11-19T07:47:58Z

cleaning up - I think this is no longer of anybody's interest

DeepDiver1975 added the 2 - Developing label Oct 4, 2023

DeepDiver1975 mentioned this pull request Oct 4, 2023

feat: php 8.2 #40981

Closed

14 tasks

DeepDiver1975 force-pushed the chore/replace-swiftmailer-with-symfony-mailer branch 2 times, most recently from 4d2c394 to ea838aa Compare October 4, 2023 20:05

phil-davis self-requested a review October 4, 2023 20:35

DeepDiver1975 force-pushed the chore/replace-swiftmailer-with-symfony-mailer branch 2 times, most recently from bc46a27 to 07a47dd Compare October 5, 2023 10:45

mmattel reviewed Oct 5, 2023

View reviewed changes

config/config.sample.php Outdated Show resolved Hide resolved

mmattel mentioned this pull request Oct 5, 2023

New Screenshot for admin email settings owncloud/docs-server#1137

Open

DeepDiver1975 force-pushed the chore/replace-swiftmailer-with-symfony-mailer branch 2 times, most recently from 026c2ac to 4d7271e Compare October 5, 2023 13:10

phil-davis mentioned this pull request Oct 6, 2023

Adjust lost controller send notification mail #41013

Closed

phil-davis reviewed Oct 6, 2023

View reviewed changes

lib/private/Mail/Mailer.php Outdated Show resolved Hide resolved

DeepDiver1975 force-pushed the chore/replace-swiftmailer-with-symfony-mailer branch from b7c4f0c to 4bfd453 Compare October 6, 2023 10:38

DeepDiver1975 added 3 - To Review and removed 2 - Developing labels Oct 6, 2023

phil-davis self-requested a review October 8, 2023 22:37

phil-davis reviewed Oct 9, 2023

View reviewed changes

DeepDiver1975 added 3 commits November 13, 2023 23:23

chore: migrate to symfony/mailer

bd79dc8

chore: remove email config mail_smtpauthtype - this is now auto det…

dd25fc9

…ected

test: fix unit tests

78585a1

DeepDiver1975 added 2 commits November 13, 2023 23:23

fix: UI and tests

0634d9f

fix: Mailer::send will always thrown an exception in case of errors d…

ad2bb6d

…uring delivery

DeepDiver1975 force-pushed the chore/replace-swiftmailer-with-symfony-mailer branch 3 times, most recently from 12e9080 to ad2bb6d Compare November 13, 2023 22:28

DeepDiver1975 closed this Nov 19, 2024

DeepDiver1975 deleted the chore/replace-swiftmailer-with-symfony-mailer branch November 19, 2024 07:48

Conversation

DeepDiver1975 commented Oct 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

QA Scenarios

Scenarios

Mail Setups to test

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

update-docs bot commented Oct 4, 2023

Uh oh!

DeepDiver1975 commented Oct 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

mmattel commented Oct 5, 2023

Uh oh!

mmattel commented Oct 5, 2023

Uh oh!

DeepDiver1975 commented Oct 5, 2023

Uh oh!

individual-it commented Oct 6, 2023

Uh oh!

Uh oh!

sonarqubecloud bot commented Oct 6, 2023

Uh oh!

phil-davis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

phil-davis Oct 9, 2023

Choose a reason for hiding this comment

Uh oh!

phil-davis Oct 9, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

phil-davis Oct 9, 2023

Choose a reason for hiding this comment

Uh oh!

DeepDiver1975 Oct 9, 2023

Choose a reason for hiding this comment

Uh oh!

phil-davis commented Oct 9, 2023

Uh oh!

DeepDiver1975 commented Oct 9, 2023

Uh oh!

sonarqubecloud bot commented Nov 13, 2023

Uh oh!

phil-davis commented Feb 5, 2024

Uh oh!

DeepDiver1975 commented Feb 5, 2024

Uh oh!

DeepDiver1975 commented Nov 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

DeepDiver1975 commented Oct 4, 2023 •

edited

Loading

DeepDiver1975 commented Oct 5, 2023 •

edited

Loading