Label bug in module configuration page (Ignition 8.1.48)

Module Development
1

I’m working on developing the configuration page for my module and when configuring the second page I came across this problem with my labels.

image
image593×210 3.41 KB

I am using a UserMfaRecord.properties file for them and I think I did everything the same way I did for the first page but somehow I can’t seem to get the labels to have the correct name. I got the category to work properly using a different .properties file (the same one I used for my first page), but when I tried using it for the labels it still didn’t change a thing. Here’s the code:

 public static class UserMfaRecord extends PersistentRecord {  
        
        public static final RecordMeta<UserMfaRecord> META = new RecordMeta<UserMfaRecord>(
                UserMfaRecord.class, "UserMfaRecord")
                .setNounKey("UserMfaRecord.Noun")
                .setNounPluralKey("UserMfaRecord.Noun.Plural");

         public interface IRecordListener<T> {

             void onRecordCreated(T record);
         }

         private static final List<IRecordListener<UserMfaRecord>> listeners = new ArrayList<>();

         public static void addRecordListener(IRecordListener<UserMfaRecord> listener) {
             listeners.add(listener);
         }

         public UserMfaRecord() {
             super();
             notifyCustomListeners(this);
         }

         public static void notifyCustomListeners(UserMfaRecord record) {
             for (IRecordListener<UserMfaRecord> listener : listeners) {
                 listener.onRecordCreated(record);
            }
         }
      

        public static final IdentityField Id = new IdentityField(META);

        public static final StringField User = new StringField(META, "User", SFieldFlags.SPRIMARY_KEY, 
        SFieldFlags.SMANDATORY, SFieldFlags.SDESCRIPTIVE);

        // public static final EncodedStringField Password
        //         = new EncodedStringField(META, "Password", SFieldFlags.SMANDATORY, SFieldFlags.SDESCRIPTIVE);
        public static final EnumField<MfaOptions> MfaOption
                = new EnumField<>(META, "MfaOption", MfaOptions.class, SFieldFlags.SMANDATORY, SFieldFlags.SDESCRIPTIVE);

        public static final Category USER_DATA
                = new Category("KeycloakSettingsRecord.Category.USER_DATA", 1000)
                        .include(User, MfaOption);

        static {
            User.setUnique(true);
            MfaOption.setDefault(MfaOptions.SMS);

        }

And here’s the properties file: UserMfaRecord.properties

User.Name=Username
MfaOption.Name=Mfa Option

If anyone has any tips I’d really appreciate the help!

2

Have you fully restarted the gateway?

There's a longstanding bug (that we're, at this point, never going to fix) where repeated calls to initialize bundles end up in a weird state where things don't quite work correctly.

3

Yes! I realized that was happening and started restarting the gateway every time I changed any labels or tried any fixes for this issue, but nothing changed. Do you know what else it could be?

4

For the sake of it, does it resolve the keys if you repeat the prefix again on the actual key literals?
As in:

UserMfaRecord.User.Name=Username
UserMfaRecord.MfaOption.Name=Mfa Option
5 
fieldNameKey = field.getRecordMeta().getUserClass().getSimpleName() + "." + field.getFieldName() + ".Name";
fieldDescriptionKey = field.getRecordMeta().getUserClass().getSimpleName() + "." + field.getFieldName() + ".Desc";`

I have no idea if this will help, but you could try running this (for development only!) in your gateway hook once:

org.apache.wicket.Application.get().getResourceSettings().getLocalizer().setEnableCache(false);
6

Yeah I tried that, it also didn’t work.

7

Sorry I didn’t really understand, where exactly should I run it?

8

In your module's GatewayHook, in the setup or startup methods, you could try running that snippet. It should, in theory, tell Wicket not to do any caching of localization data, which might help with the "having to restart the gateway every time" problem.

Won't help with the actual observed issue here, though, I don't think.

9

I've found that BundleUtil works best when called in the gateway hook's constructor, not in any of the lifecycle methods. FWIW.

(Crucial for v8.3, fwiw.)

1 Like