SPFx Field Customizer - onInit executes multiple times when navigating between folders in same document library

[SaadKnowIT]

Target SharePoint environment

SharePoint Online

What SharePoint development model, framework, SDK or API is this about?

💥 SharePoint Framework

Developer environment

No response

What browser(s) / client(s) have you tested

• 💥 Internet Explorer
• 💥 Microsoft Edge
• 💥 Google Chrome
• 💥 FireFox
• 💥 Safari
• mobile (iOS/iPadOS)
• mobile (Android)
• not applicable
• other (enter in the "Additional environment details" area below)

Additional environment details

Versions:

• Microsoft Edge version: Version 107.0.1418.26 (Official build) (64-bit)
• Chrome version: Version 106.0.5249.119 (Official Build) (64-bit)
• SPFx version: 1.15.2
• Node.js version: 16.13.0 (64-bit)

Describe the bug / error

I am developing an SPFx Extension Field Customizer that is supposed to run in an document library with many levels of folders and documents.

The problem i am having is that the "onInit" function is executed multiple times when navigating between the folders in the document library. I am executing an request to SharePoint through the PnPJs library from inside the onInit function.

On initial visit to the document library, this is the order of how the default function execute:

If i decide to navigate in to one of these folders from this view, then this is the execution order of the default functions:

If i navigate back up to the root folder and then to a different folder (still one level down). Then this is the execution order of the default functions:

If i right click on a document or a folder in the same view as above to open the object menu, it triggers the default functions again:

This behavior i explained above continues as i navigate to a new folder in the same document library. For every new folder i navigate to, the execution count for the onInit executions increase by one.

Steps to reproduce

1. Create a new SPFx Extension - Field Customizer with React as a template using yo.

2. Add these for the console log outputs as show in my pictures above.
   

3. Add the column associated with your Field Customizer to a document library.

4. run gulp serve and test it against the document library.

Expected behavior

I expect the oninit function to be executed only once for each navigation event made between the folders.

[ghost]

Thank you for reporting this issue. We will be triaging your incoming issue as soon as possible.

[SaadKnowIT]

@AJIXuMuK, any idéa why this is happening? Is this expected behavior? Any workaround?

[SaadKnowIT]

@andrewconnell & @VesaJuvonen, do you guys have any insight into this?

[AJIXuMuK]

@SaadKnowIT - sorry for the silence.
I'm able to repro it and will be working on the fix.

[SaadKnowIT]

@AJIXuMuK - Glad to here that you are working on this. Waiting for your findings/results.

[AJIXuMuK]

@SaadKnowIT - the issue has been fixed and will be included in the next release.
To set the expectations: onInit will be called once per customizer/list.
It means that it may not be called if you navigate between 2 lists because the state of the list is cached and the customizer has been already initialized. Don't use this handler to handle navigation of any type.

[SaadKnowIT]

@AJIXuMuK, thanks for the reply and the fix. Will test it when it is released.

What am i supposed to use to handle navigation events (Navigating between folders) inside the same library/list or when navigating between different libraries/lists.

[AJIXuMuK]

this should be rolled out worldwide by now

[ghost]

Issues that have been closed & had no follow-up activity for at least 7 days are automatically locked. Please refer to our wiki for more details, including how to remediate this action if you feel this was done prematurely or in error: Issue List: Our approach to locked issues