[v3] migrating to null safety

[aissat]

No description provided.

[acoutts]

Hi there is something wrong on this branch- when a key isn't found, the app hits an exception. In the old lib, if a key wasn't found, it failed silently so it didn't interrupt the app in any unexpected manner.

Unhandled exception:
Exception: Cannot cache a key that is not nested.
#0      Translations.getNested (package:easy_localization/src/translations.dart:24:7)
#1      Translations.get (package:easy_localization/src/translations.dart:7:27)
#2      Localization.Eval ()
#3      Localization._resolve (package:easy_localization/src/localization.dart:171:18)

Seems like isNested() returns true on keys which aren't found.

Ahh, so if the string contains a period it's now confused because it thinks it's a nested string key!

ie: 'Processing...'.tr() doesn't work with the nested stuff.

Can we optionally disable nested checks completely? I don't want to use a foo.bar.baz key setup, i want to simply use english strings within the app and match it exactly to the json keys.

[aissat]

Hi there is something wrong on this branch- when a key isn't found, the app hits an exception. In the old lib, if a key wasn't found, it failed silently so it didn't interrupt the app in any unexpected manner.

Unhandled exception:
Exception: Cannot cache a key that is not nested.
#0      Translations.getNested (package:easy_localization/src/translations.dart:24:7)
#1      Translations.get (package:easy_localization/src/translations.dart:7:27)
#2      Localization.Eval ()
#3      Localization._resolve (package:easy_localization/src/localization.dart:171:18)

Seems like isNested() returns true on keys which aren't found.

Ahh, so if the string contains a period it's now confused because it thinks it's a nested string key!

ie: 'Processing...'.tr() doesn't work with the nested stuff.

Can we optionally disable nested checks completely? I don't want to use a foo.bar.baz key setup, i want to simply use english strings within the app and match it exactly to the json keys.

hi @acoutts plz more detailed example for this bug

[acoutts]

Add this in your json file:

{
  "Please tap the button..": "Please tap the button.."
}

Then in your app,

Text('Please tap the button..'.tr())

The key is the lang key should contain a period.

[aissat]

Add this in your json file:

{
  "Please tap the button..": "Please tap the button.."
}

Then in your app,

Text('Please tap the button..'.tr())

The key is the lang key should contain a period.

@acoutts I write test case for this

      test('instance.tr() ', () {
        expect(Localization.instance.tr('Please tap the button..'), 'Please tap the button..');
      });

      test('tr()', () {
        expect(tr('Please tap the button..'), 'Please tap the button..');
      });

      test('ext tr()', () {
        expect('Please tap the button..'.tr(), 'Please tap the button..');
      });

test passed

[acoutts]

Hm how strange! So how does the nested key logic distinguish between if you are doing foo.bar.baz nested JSON vs Some full sentence... at the root level?

[aissat]

@acoutts this is some nested test case

easy_localization/test/utils/test_asset_loaders.dart

Line 33 in bc8f6da

'nested.but.not.nested': 'nested but not nested',

easy_localization/test/utils/test_asset_loaders.dart

Lines 48 to 57 in bc8f6da

	'nested': {
	'super': {
	'duper': {
	'nested': 'nested.super.duper.nested',
	'nested_with_arg': 'nested.super.duper.nested_with_arg {}',
	'nested_with_named_arg':
	'nested.super.duper.nested_with_named_arg {arg}'
	}
	}
	},

easy_localization/test/easy_localization_test.dart

Lines 136 to 147 in bc8f6da

	test('can resolve resource in any nest level', () {
	expect(
	Localization.instance.tr('nested.super.duper.nested'),
	'nested.super.duper.nested',
	);
	});
	test('can resolve resource that has a key with dots', () {
	expect(
	Localization.instance.tr('nested.but.not.nested'),
	'nested but not nested',
	);
	});

easy_localization/test/easy_localization_test.dart

Lines 219 to 225 in bc8f6da

	test('returns resource and replaces argument in any nest level', () {
	expect(
	Localization.instance
	.tr('nested.super.duper.nested_with_arg', args: ['what a nest']),
	'nested.super.duper.nested_with_arg what a nest',
	);
	});

[acoutts]

Ah very cool- thanks for showing! Can you see if having 3 periods breaks it? That's the only difference I found from my app vs the test there.

[aissat]

@acoutts check this maybe your issue related to #337 #331 or if u can create an example or test case failed

[acoutts]

Thanks! That looks related to my issue.

One other thing, I tried to disable the log messages for tests:

  EasyLocalization.logger.enableLevels = <LevelMessages>[LevelMessages.error];

But this one still prints every time a test starts:

[🌎 Easy Localization] [DEBUG] Localization initialized

Is there a way to hide that one?

[acoutts]

Ok I found how to reproduce the issue. The issue is if you try to reference a key that doesn't exist, and that key has a period in it.

      test('won\'t fail for missing key with consecutive dots', () {
        expect(
          Localization.instance.tr('Processing.'),
          'Processing.',
        );
      });

Exception: Cannot cache a key that is not nested.
package:easy_localization/src/translations.dart 24:7    Translations.getNested
package:easy_localization/src/translations.dart 7:27    Translations.get
package:easy_localization/src/localization.dart 171:35  Localization._resolve
package:easy_localization/src/localization.dart 53:13   Localization.tr
test/easy_localization_test.dart 163:33                 main.<fn>.<fn>.<fn>

Problem is the logic here:

  bool isNestedKey(String key) =>
      !_translations!.containsKey(key) && key.contains('.');

[acoutts]

Yeah this is tough. I don't think you can figure out if the user is using

• nested keys welcome_screen.password.title
• sentences Hello. Welcome to the app
• nested sentences welcome_screen.Welcome to the app
  etc

[acoutts]

I was able to fix the logic so it won't fail on missing keys with periods, and all of the tests are passing including the shared preferences null error. I had to put SharedPreferences.setMockInitialValues({}); before await EasyLocalization.ensureInitialized();.

I created this PR to put the changes into your branch: #341

All tests are now passing.

[aissat]

@acoutts nice work 👍

[acoutts]

Thanks! Love this package, glad I could help.

Yeah this is tough. I don't think you can figure out if the user is using

• nested keys welcome_screen.password.title
• sentences Hello. Welcome to the app
• nested sentences welcome_screen.Welcome to the app
  etc

This is the only head scratcher. I almost think the user needs to give a hint here what kind of key they are using.

[aissat]

Thanks! Love this package, glad I could help.

Yeah this is tough. I don't think you can figure out if the user is using

• nested keys welcome_screen.password.title
• sentences Hello. Welcome to the app
• nested sentences welcome_screen.Welcome to the app
  etc

This is the only head scratcher. I almost think the user needs to give a hint here what kind of key they are using.

thnx @acoutts , welcome anytime