DynamicDataSharedDepth undefined in hosted workbench (SPFx 1.8.1)

[YannickRe]

Category

• Question
• Typo
• Bug
• Additional article idea

Expected or Desired Behavior

When running an SPFx 1.8.1 solution that uses Dynamic Data with 'gulp serve', I expect it to work correctly in the local workbench, the hosted workbench and SharePoint pages.

Observed Behavior

Running the solution works without an issue in the local workbench and SharePoint pages, but in the hosted workbench it throws the following exception: "Cannot read property 'Source' of undefined". Issues occurs with DynamicDataSharedDepth.Source

The error doesn't occur when using SPFx 1.7.1. It starts occurring when I upgraded the solution to 1.8.1 with the guidance from the Office 365 CLI and only when opening the Property Pane.
Also occurs in a newly created solution. Tested on 3 different tenants, with Google Chrome.

Steps to Reproduce

• Create new SPFx 1.8.1 solution, keep defaults and I based it on React
• Put the following code in the existing groupFields array of the property pane (update the imports):

PropertyPaneDynamicFieldSet({
                  label: "Keywords",

                  fields: [
                      PropertyPaneDynamicField('queryKeywords', {
                          label: "Keywords"
                      })
                  ],
                  sharedConfiguration: {
                      depth: DynamicDataSharedDepth.Source,
                  },
                })

• Run gulp serve.
• Open the property pane of the webpart. In the local workbench, it works. In the hosted workbench, you will find the following error in the developer console:

Uncaught (in promise) TypeError: Cannot read property 'Source' of undefined
    at HelloWorldWebPart.getPropertyPaneConfiguration (HelloWorldWebPart.ts:65)
    at sp-webpart-workbench-assembly_en-us_adc4bc24c9e68c9e1b136ddf960e5a9d.js:605

[msft-github-bot]

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

[patmill]

Just to clarify. The local workbench is the one served from localhost, the hosted workbench is the one in SPO. Is it the local workbench that is failing?

[YannickRe]

@patmill no, it is the hosted one that fails. The local one AND the SharePoint pages work without issues.

[patmill]

So that's certainly strange. DynamicDataSharedDepth is undefined? That's an enum... What package are you importing it from? Can you make sure that it is sp-property-pane?

[YannickRe]

I tried both the old one (SP-webpart-base) and the new one (SP-property-pane), both resulting in the same behavior locally (works) and hosted (doesn’t work).

[patmill]

OK, so it is only 1.8.1 that does this, not 1.8.0. digging in more.

[patmill]

OK - figured it out. A seemingly innocuous change. We will work on getting a proper fix rolled out, and you won't need to modify your code. In the meantime, if you want to work around this, use a hard coded value (0,1,2) rather than the enum.

[YannickRe]

Thank you for figuring it out! I’ll wait for the fix to roll out, it isn’t that pressing.