Bug with Lazy Loaded feature modules

[bmalinconico]

Hello,

The following PR introduced a bug related to lazy loaded feature modules: https://github.com/btroncone/ngrx-store-localstorage/pull/76/files

The net effect of this PR is to re-hydrate the state when every feature module is loaded, and this breaks sections of the state which are selectively serialized (localStorageSync({keys: [{todos: ['name', 'status'] }, ... ]}))).

The result is the state being rehydrated and deleting all other keys not in local storage.

[philjones88]

I’ve just hit this too

[bmalinconico]

@philjones88 Possible solution that works for my usage: #94

[btroncone]

@bmalinconico Do you want to take the lead on this? I can make you a collaborator to this project. I am not able to put much time into this right now and do not want to be a bottleneck.

[bmalinconico]

@btroncone Sure, I think the biggest risk of my PR is the kinda "stupid" way it determines the state key name const name = Object.keys(key)[0]; What do you want me to do beyond deal with bugs I create myself? :)

[btroncone]

@bmalinconico Really looking for another extra set of eyes that is using this library every day. Need help determining priority and impact of some of the proposed PR's / issues.

[tanyagray]

I pulled it down but had problems getting the tests running. I'm also hesitant to merge anything that's untested cos I'm not a "regular" user as such. I do use feature modules though so maybe @bmalinconico we could collab on this one? Happy to live chat elsewhere.

[btroncone]

@tanyagray Agree, definitely want to be careful here. Thanks for taking a look! 👍

[bmalinconico]

@tanyagray odd, tests ran fine for me. Was it a suite error or a test failure?

[bmalinconico]

@tanyagray I'd be happy to collab on this if we can find time. I'm on the east coast of the USA and am really only on during work hours.

[magnattic]

Is there a workaround or older version to revert to? I just introduced lazy loaded modules to my project and this resets my state when loading the module.

[bmalinconico]

@magnattic My PR (#94) works for my use-case and I'm using it in production.

In your package.json

    "ngrx-store-localstorage": "https://github.com/bmalinconico/ngrx-store-localstorage.git#fix_partial_rehydration_of_keys_dist",

However I started by reverting to 0.3.0 and that worked for me too but had its own issues relate to feature modules.

[magnattic]

Thanks for providing your PR. Unfortunately I can't get it to work with my setup:
I get an

ERROR TypeError: keys.map is not a function

in mergePartialStates, this is the line:

keys.map(function (key) { return newValues_1[key] = rehydratedState[name_2][key]; });

The problem seems to be that it's not compatible with the custom serialize/deserialize functions I am using. This is my setup:

export function localStorageSyncReducer(reducer: ActionReducer<any>): ActionReducer<any> {
  return localStorageSync({
    keys: [
      {
        shop: {
          deserialize: (json: any) => {
            const jsonFixed = fixInvalidCombinations(fixOldState(json));
            return _.defaultsDeep(jsonFixed, { homePage: fromHomepage.initialState, prospect: fromProspect.initialState });
          },
          serialize: (state: ShopState) => {
            const { numCardsVisible, ...serializedHomePage } = state.homePage;
            return { homePage: serializedHomePage, prospect: state.prospect };
          }
        }
      },
      {
        checkout: {
          deserialize: (json: any) => _.defaultsDeep(json, { customer: fromCustomer.initialState })
        }
      }
    ],
    rehydrate: true
  })(reducer);
}

[bmalinconico]

@magnattic I see what is wrong, and can update the PR. It looks like you serializing the entire shop and checkout state?

If you are I'll make a small adjustment, but if you are serializing the whole state you are probably running into a different problem then I was trying to solve.