cancel
Showing results for 
Search instead for 
Did you mean: 
Reply
shadowfox
Helper I
Helper I

Change in PCF Controls load null data on initial load

Recently a control I have had published for quiet some time started to break (in July). This code base has not changed and has been working fine for some time. Trying to determine what update is causing this change in behavior. The issue is on initial load the field mapped to the control shows null data. But if you do a post back again (F5) it will work on the second load and if you exit the record and re-open it will work fine. Trying to understand why all of a sudden it's displaying null on initial load. As I have said - the code hasn't changed since Mar 18, 2020.  This is a modified version of the PeoplePicker control -

 

import { IInputs, IOutputs } from "./generated/ManifestTypes";
import * as React from 'react';
import * as ReactDOM from 'react-dom';
import { PeoplePickerTypes, IPeopleProps, IPeoplePersona } from './Peoplepicker';

export class OfficeUIFabricReactPeoplePicker implements ComponentFramework.StandardControl<IInputs, IOutputs> {
	private theContainer: HTMLDivElement;
	private notifyOutputChanged: () => void;
	private _context: ComponentFramework.Context<IInputs>;
	private props: IPeopleProps = {
		//tableValue: this.numberFacesChanged.bind(this),
		peopleList: this.peopleList.bind(this),
	}

	/**
	 * Empty constructor.
	 */
	constructor() {

	}

	/**
	 * Used to initialize the control instance. Controls can kick off remote server calls and other initialization actions here.
	 * Data-set values are not initialized here, use updateView.
	 * @Param context The entire property bag available to control via Context Object; It contains values as set up by the customizer mapped to property names defined in the manifest, as well as utility functions.
	 * @Param notifyOutputChanged A callback method to alert the framework that the control has new outputs ready to be retrieved asynchronously.
	 * @Param state A piece of data that persists in one session for a single user. Can be set at any point in a controls life cycle by calling 'setControlState' in the Mode interface.
	 * @Param container If a control is marked control-type='standard', it will receive an empty div element within which it can render its content.
	 */
	public init(context: ComponentFramework.Context<IInputs>, notifyOutputChanged: () => void, state: ComponentFramework.Dictionary, container: HTMLDivElement) {
		// Add control initialization code
		this.notifyOutputChanged = notifyOutputChanged;
		this._context = context;
		this.theContainer = container;
	}


	/**
	 * Called when any value in the property bag has changed. This includes field values, data-sets, global values such as container height and width, offline status, control metadata values such as label, visible, etc.
	 * @Param context The entire property bag available to control via Context Object; It contains values as set up by the customizer mapped to names defined in the manifest, as well as utility functions
	 */
	public async updateView(context: ComponentFramework.Context<IInputs>) {
		// Add code to update control view
		this.props.context = context;
		if (context.parameters.peoplePicker.raw !== null) {
			if (context.parameters.peoplePicker.raw!.indexOf("text") > 1) {
				this.props.preselectedpeople = JSON.parse(context.parameters.peoplePicker.raw!);
			}
		}

		ReactDOM.render(
			React.createElement(
				PeoplePickerTypes,
				this.props
			),
			this.theContainer
		);

	}

	/** 
	 * It is called by the framework prior to a control receiving new data. 
	 * @returns an object based on nomenclature defined in manifest, expecting object[s] for property marked as “bound” or “output”
	 */
	public getOutputs(): IOutputs {
		return {
			peoplePicker: JSON.stringify(this.props.people)
		};
	}

	private peopleList(newValue: IPeoplePersona[]) {
		if (this.props.people !== newValue) {
			if (newValue.length === 0) {
				this.props.people = undefined;
			}
			else {
				this.props.people = newValue;
			}

			this.notifyOutputChanged();
		}
	}

	/** 
	 * Called when the control is to be removed from the DOM tree. Controls should use this call for cleanup.
	 * i.e. cancelling any pending remote calls, removing listeners, etc.
	 */
	public destroy(): void {
		// Add code to cleanup control if necessary
		ReactDOM.unmountComponentAtNode(this.theContainer);
	}
}

 

1 ACCEPTED SOLUTION

Accepted Solutions

No, the "null first, value second" thing is something I've seen before, that's why I knew to guess it. I am not sure how to reliably reproduce (or avoid) it, which is why I just take approaches that circumvent it. So again, make sure your nullcheck is safe (you already have a !== null, so that should safely avoid any exceptions) then add in a line right before your reactdom.render, basically the same thing you are doing in Dispose:

 

ReactDOM.unmountComponentAtNode(this.theContainer);

 

This will let your component run once, with a null string, which will render nothing in the picker. But then when updateView gets called again and has a value, it will unload that empty version of the control and reload with an actual value.

View solution in original post

18 REPLIES 18
cchannon
Multi Super User
Multi Super User

Nothing is jumping out at me as problematic in this code. What do you see when you debug the control using browser developer tools?

DianaBirkelbach
Most Valuable Professional
Most Valuable Professional

Hi @shadowfox 

 

 I don't know if that has something to do with it, but what's the reason of searching the "text" inside the peoplePicker parameter?

context.parameters.peoplePicker.raw!.indexOf("text")

 

If after the reload it works, maybe the first render triggers the "peopleList" witch changes the value.


Otherweise, I agree with @cchannon  , it depends on which values are passed to updateView when it's triggered. 

 

Kind regards,

Diana

 

Kind regards,
Diana
----------
Please click "Accept as Solution" if my post answered your question so that others may find it more quickly. If you found this post helpful consider giving it a "Thumbs Up."

@cchannon When using the debug tool - on the initial load when it first hits the updateview this is what I see (image below which shows the field being null) -

shadowfox_0-1628085445069.png

But then on the second call of the updateview is shows the data but at this point it's not rendering.

shadowfox_1-1628085522565.png

If I close the page and re-open the initial load this time has a value - 

shadowfox_2-1628085618220.png

This is the part that makes no sense to me. The fact on a cold load - the initial is null but then after closing and re-opening it's fine. As I said - this has been working wonderfully for over a year with no issues but this behavior just started. I did also try to update my npm packages and see if that fixed it but no luck.

 

Thanks.

 

@DianaBirkelbach thanks for the reply! The indexOf("text") is verifying the JSON has the label text in it to get the label for the control. Otherwise if text is missing, then the JSON main part is malformed and won't work. Hope that helps better explain that. Sadly - with the issue I'm having - I'm not hitting this part since the field is passing null on the initial cold load.

 

Thanks!

DianaBirkelbach
Most Valuable Professional
Most Valuable Professional

Hi @shadowfox , 

 

Now I'm making some wild guessing.
Maybe the "this.props" makes some trouble because the props is reserved in react, and the PCFs are based on react. Thinking of it, you actually don't need the private "props" in your class, which you also pass as a reference to the component PeoplePickerTypes as props. I also suppose that the changing of the content inside the props won't be reflected, since you render the PeoplePickerTypes with the same reference of the props, but you change the content (props should be immutable).

In your class, you only need the value (in your case the people).
So I suggest, not to define a private "props" in your class. The props you pass to your PeoplePickerTypes can be defined just where you call the render function. All you need to keep in the class is the value for people, and the function itself (peopleList).

 

I've also saw that the updateView is declared "async". Not so sure if it's supposed to work that way, but I also don't see where you have the await. I suggest to delete the async.

 

It the explanation is not clear enough, please let me know.

Hope it helps.

 

Kind regards,

Diana

Kind regards,
Diana
----------
Please click "Accept as Solution" if my post answered your question so that others may find it more quickly. If you found this post helpful consider giving it a "Thumbs Up."

@shadowfox When you say, "the field is passing null" do you mean

context.parameters.peoplePicker.raw

is coming through as null even though the attrib does contain a JSON value?

@cchannon Yes - that was on the debugger image I grabbed. The context.parameters.peoplePicker.raw is null on initial cold load. Very crazy - this is something new I'm experiencing. 

@DianaBirkelbach thanks for the reply. You did catch something I was trying just to see if it made a difference but it didn't. Here is the original code for that part. I was initially just using context.parameters.peoplePicker.raw but wanted to see if the this.props.context made any difference (mostly because I'm stuck and nothing else I tried worked so figured I'd try it just to rule it out). As for the async - this was initially developed as part of the PCF Gallery control - People Picker | PCF Gallery. I have modified the React code quiet a bit to handle any entity and fixed an issue with the async promise. But the index.ts page has been left untouched since I pulled it down. What's blogging my head its been working for over a year now just fine. This makes me think something with how controls are being rendered on cold load and binding has been changed. Thanks for the help!

public async updateView(context: ComponentFramework.Context<IInputs>) {
		// Add code to update control view
		this.props.context = context;
		if (context.parameters.peoplePicker.raw !== null) {
			if (context.parameters.peoplePicker.raw!.indexOf("text") > 1) {
				this.props.preselectedpeople = JSON.parse(context.parameters.peoplePicker.raw!);
			}
		}

		ReactDOM.render(
			React.createElement(
				PeoplePickerTypes,
				this.props
			),
			this.theContainer
		);

	}

 

Well, updateView gets called multiple times onLoad (at least two, could be more depending on what's happening on your form) and you can even force it to fire with Client Script by using the fireOnChange() function.

 

So try debugging again and just put your breakpoint at the top of updateView. Is contex.parameters.peoplePicker null every time updateView gets called, or maybe just the first time?

Helpful resources

Announcements

Tuesday Tip | How to Report Spam in Our Community

It's time for another TUESDAY TIPS, your weekly connection with the most insightful tips and tricks that empower both newcomers and veterans in the Power Platform Community! Every Tuesday, we bring you a curated selection of the finest advice, distilled from the resources and tools in the Community. Whether you’re a seasoned member or just getting started, Tuesday Tips are the perfect compass guiding you across the dynamic landscape of the Power Platform Community.   As our community family expands each week, we revisit our essential tools, tips, and tricks to ensure you’re well-versed in the community’s pulse. Keep an eye on the News & Announcements for your weekly Tuesday Tips—you never know what you may learn!   Today's Tip: How to Report Spam in Our Community We strive to maintain a professional and helpful community, and part of that effort involves keeping our platform free of spam. If you encounter a post that you believe is spam, please follow these steps to report it: Locate the Post: Find the post in question within the community.Kebab Menu: Click on the "Kebab" menu | 3 Dots, on the top right of the post.Report Inappropriate Content: Select "Report Inappropriate Content" from the menu.Submit Report: Fill out any necessary details on the form and submit your report.   Our community team will review the report and take appropriate action to ensure our community remains a valuable resource for everyone.   Thank you for helping us keep the community clean and useful!

Tuesday Tip | How to Get Community Support

It's time for another Tuesday Tip, your weekly connection with the most insightful tips and tricks that empower both newcomers and veterans in the Power Platform Community! Every Tuesday, we bring you a curated selection of the finest advice, distilled from the resources and tools in the Community. Whether you’re a seasoned member or just getting started, Tuesday Tips are the perfect compass guiding you across the dynamic landscape of the Power Platform Community.       This Week: All About Community Support Whether you're a seasoned community veteran or just getting started, you may need a bit of help from time to time! If you need to share feedback with the Community Engagement team about the community or are looking for ways we can assist you with user groups, events, or something else, Community Support is the place to start.   Community Support is part of every one of our communities, accessible to all our community members.   Within each community's Community Support page, you'll find three distinct areas, each with a different focus to help you when you need support from us most. Power Apps: https://powerusers.microsoft.com/t5/Community-Support/ct-p/pa_community_support Power Automate: https://powerusers.microsoft.com/t5/Community-Support/ct-p/mpa_community_support Power Pages: https://powerusers.microsoft.com/t5/Community-Support/ct-p/mpp_community_support Copilot Studio: https://powerusers.microsoft.com/t5/Community-Support/ct-p/pva_community-support   Community Support Form If you need more assistance, you can reach out to the Community Team via the Community support form. Choose the type of support you require and fill in the form accordingly. We will respond to you promptly.    Thank you for being an active part of our community. Your contributions make a difference!   Best Regards, The Community Management Team

Community Roundup: A Look Back at Our Last 10 Tuesday Tips

As we continue to grow and learn together, it's important to reflect on the valuable insights we've shared. For today's #TuesdayTip, we're excited to take a moment to look back at the last 10 tips we've shared in case you missed any or want to revisit them. Thanks for your incredible support for this series--we're so glad it was able to help so many of you navigate your community experience!   Getting Started in the Community An overview of everything you need to know about navigating the community on one page!  Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Community Ranks and YOU Have you ever wondered how your fellow community members ascend the ranks within our community? We explain everything about ranks and how to achieve points so you can climb up in the rankings! Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Powering Up Your Community Profile Your Community User Profile is how the Community knows you--so it's essential that it works the way you need it to! From changing your username to updating contact information, this Knowledge Base Article is your best resource for powering up your profile. Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Community Blogs--A Great Place to Start There's so much you'll discover in the Community Blogs, and we hope you'll check them out today!  Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Unlocking Community Achievements and Earning Badges Across the Communities, you'll see badges on users profile that recognize and reward their engagement and contributions. Check out some details on Community badges--and find out more in the detailed link at the end of the article! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Blogging in the Community Interested in blogging? Everything you need to know on writing blogs in our four communities! Get started blogging across the Power Platform communities today! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Subscriptions & Notifications We don't want you to miss a thing in the community! Read all about how to subscribe to sections of our forums and how to setup your notifications! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Getting Started with Private Messages & Macros Do you want to enhance your communication in the Community and streamline your interactions? One of the best ways to do this is to ensure you are using Private Messaging--and the ever-handy macros that are available to you as a Community member! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Community User Groups Learn everything about being part of, starting, or leading a User Group in the Power Platform Community. Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Update Your Community Profile Today! Keep your community profile up to date which is essential for staying connected and engaged with the community. Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Thank you for being an integral part of our journey.   Here's to many more Tuesday Tips as we pave the way for a brighter, more connected future! As always, watch the News & Announcements for the next set of tips, coming soon!

Hear what's next for the Power Up Program

Hear from Principal Program Manager, Dimpi Gandhi, to discover the latest enhancements to the Microsoft #PowerUpProgram, including a new accelerated video-based curriculum crafted with the expertise of Microsoft MVPs, Rory Neary and Charlie Phipps-Bennett. If you’d like to hear what’s coming next, click the link below to sign up today! https://aka.ms/PowerUp  

Tuesday Tip: Community User Groups

It's time for another TUESDAY TIPS, your weekly connection with the most insightful tips and tricks that empower both newcomers and veterans in the Power Platform Community! Every Tuesday, we bring you a curated selection of the finest advice, distilled from the resources and tools in the Community. Whether you’re a seasoned member or just getting started, Tuesday Tips are the perfect compass guiding you across the dynamic landscape of the Power Platform Community.   As our community family expands each week, we revisit our essential tools, tips, and tricks to ensure you’re well-versed in the community’s pulse. Keep an eye on the News & Announcements for your weekly Tuesday Tips—you never know what you may learn!   Today's Tip: Community User Groups and YOU Being part of, starting, or leading a User Group can have many great benefits for our community members who want to learn, share, and connect with others who are interested in the Microsoft Power Platform and the low-code revolution.   When you are part of a User Group, you discover amazing connections, learn incredible things, and build your skills. Some User Groups work in the virtual space, but many meet in physical locations, meaning you have several options when it comes to building community with people who are learning and growing together!   Some of the benefits of our Community User Groups are: Network with like-minded peers and product experts, and get in front of potential employers and clients.Learn from industry experts and influencers and make your own solutions more successful.Access exclusive community space, resources, tools, and support from Microsoft.Collaborate on projects, share best practices, and empower each other. These are just a few of the reasons why our community members love their User Groups. Don't wait. Get involved with (or maybe even start) a User Group today--just follow the tips below to get started.For current or new User Group leaders, all the information you need is here: User Group Leader Get Started GuideOnce you've kicked off your User Group, find the resources you need:  Community User Group ExperienceHave questions about our Community User Groups? Let us know! We are here to help you!

Super User of the Month | Ahmed Salih

We're thrilled to announce that Ahmed Salih is our Super User of the Month for April 2024. Ahmed has been one of our most active Super Users this year--in fact, he kicked off the year in our Community with this great video reminder of why being a Super User has been so important to him!   Ahmed is the Senior Power Platform Architect at Saint Jude's Children's Research Hospital in Memphis. He's been a Super User for two seasons and is also a Microsoft MVP! He's celebrating his 3rd year being active in the Community--and he's received more than 500 kudos while authoring nearly 300 solutions. Ahmed's contributions to the Super User in Training program has been invaluable, with his most recent session with SUIT highlighting an incredible amount of best practices and tips that have helped him achieve his success.   Ahmed's infectious enthusiasm and boundless energy are a key reason why so many Community members appreciate how he brings his personality--and expertise--to every interaction. With all the solutions he provides, his willingness to help the Community learn more about Power Platform, and his sheer joy in life, we are pleased to celebrate Ahmed and all his contributions! You can find him in the Community and on LinkedIn. Congratulations, Ahmed--thank you for being a SUPER user!  

Users online (3,551)