Convert spam role to junk

[jip149]

According to the JMAP specification, the role for the Spam/Junk mailbox should be junk. However, some servers and client incorrectly use spam role (which does not exist in the spec).

This PR modifies the Role constructor to treat the spam role as junk.

Tests have been updated and written, however, it has not yet been tested in TwakeMail (work in progress).

[jip149]

This is somehow unrelated, but could you explain why the Role constructor (and some other classes as well) is not const?

This would avoid the equatable mixin and lessen memory usage?

See https://dartpad.dev/?id=ab64c61ac6bc10e6b0c577656da73781

[dab246]

This is somehow unrelated, but could you explain why the Role constructor (and some other classes as well) is not const?

This would avoid the equatable mixin and lessen memory usage?

See https://dartpad.dev/?id=ab64c61ac6bc10e6b0c577656da73781

We use Equatable to compare two objects to see if they are the same instance. Please use identical to check whether two references are to the same object.

Please run code on dartpad to see result

import 'package:equatable/equatable.dart';

class RoleA with EquatableMixin {
  final String value;

  RoleA(value) : value = value == "spam" ? "junk" : value;

  @override
  List<Object?> get props => [value];
}

class RoleB {
  final String value;

  const RoleB(value) : value = value == "spam" ? "junk" : value;
}

void main() {
  final junkA = RoleA("junk");
  final spamA = RoleA("spam");
  const junkB = RoleB("junk");
  const spamB = RoleB("spam");

  print('junkA == spamA ${junkA == spamA}');
  print('junkB == spamB ${junkB == spamB}');
  print('identical(junkA, spamA) ${identical(junkA, spamA)}');
  print('identical(junkB, spamB) ${identical(junkB, spamB)}');
}

[hoangdat]

Hi @jip149, can you give me some examples of problem with it?
I have only one concern now, client app maybe impacted if we forced to use junk.

[jip149]

@hoangdat this is related to tmail-flutter issue #2894

I'll try to test today if the patch indeed work as expected.

@dab246 Thank you for your reply. I understand how equatable and identical work. My question is, why not use compile time constants for Role objects?

[chibenwa]

Thanks a lot for the contribution!

[jip149]

I managed to compile TwakeMail using flutter 3.16. I have not yet fully tested all Spam related functions, but I confirm the correct folder is now used with Stalwart.

I'll do some more testing with Stalwart. Can you test that it still works with JAMES?

[dab246]

@dab246 Thank you for your reply. I understand how equatable and identical work. My question is, why not use compile time constants for Role objects?

We've been developing it for quite some time, and at that time we thought it might need to change its property values ​​after initialization, so we didn't set const for it. anw, If Role only holds the role of entry data from the server we should use const to improve the performance of the program.

[chibenwa]

I'll do some more testing with Stalwart. Can you test that it still works with JAMES?

Yes, still work.

[jip149]

@dab246 Thank you for your reply. I understand how equatable and identical work. My question is, why not use compile time constants for Role objects?

We've been developing it for quite some time, and at that time we thought it might need to change its property values ​​after initialization, so we didn't set const for it. anw, If Role only holds the role of entry data from the server we should use const to improve the performance of the program.

Thanks, that makes sense. What I said was actually a mistake: since Role are also created from network data, they can't be compile time constant from a const constructor. It's still possible to have all Role('something') objects be identical (and thus reduce memory usage) by a using factory constructor.

Thanks again for your patience and explanations, it's much more clearer now.

[hoangdat]

Hi, @jip149 , we had one side effect

tmail had the query to server like that:

With your change, tmail-client failed to get the good response from James (James does not aware junk)

[jip149]

Hello @hoangdat!

Thank you very much for your feedback. Can you tell me more precisely what doesn't work and how I can reproduce the problem?

I suspect the problem comes from the capital 'S' at the beginning of Spam. According to the spec, the role must be lowercase. Are you sure this was working before?