feat(docgen): docgen sidebar base

[rustam-e]

Added: a docgen sidebar

1. loads if the previewed file is a docgen template
2. renders list of tags
3. includes empty, loading and error states

[CLAassistant]

All committers have signed the CLA.

[tjuanitas]

took a look but I don't have a lot of context on this feature. do you have a teammate that's able to review as well? also really important to get Preview's input

[bfoxx1906]

Left one comment about using features. Other than that it should be good.

[bfoxx1906]

Should we have an await here? Is checkDocGenTemplate async?

[rustam-e]

no that's not necessary, checkDocGenTemplate will reset the isDocgenTemplate prop which will be responsible for deciding whether to display or not display the sidebar and whether to navigate to the docgen tab

[bfoxx1906]

Left a few more comments.

[tjuanitas]

this looks like it could be extracted to a utils file

[rustam-e]

it's only used in this file and nowhere else, that's why I put it next to its consumer. I'd leave it as it is until we need to use it in multiple places.

[tjuanitas]

the way the enabled property is being used seems similar to how the other tabs are using the has[...] props below. are we able to follow that pattern here?

[rustam-e]

here's the difference:
enabled determined if the docgen feature is enabled for user / enterprise - it is based on permissions and feature flags
isDocGenTemplate is determined by whether a file is a docgen template which is retrieved via checkDocGenTemplate

if both happen to be true, we can render the sidebar. I am calling that hasDocGen in the Sidebar component that passes it to SidebarPanels and SidebarNav and is used consistently with the other tabs.

[rustam-e]

in other words it's not enough for a docgen feature to be enabled to dispaly the sidebar tab - the file also needs to be a template

[tjuanitas]

there is a network request in ContentSidebar to retrieve metadata, are we able to move some of the logic there so multiple calls aren't made?

box-ui-elements/src/elements/content-sidebar/ContentSidebar.js

Line 249 in 6b8fc21

fetchMetadata(): void {

I'm thinking something like:

// inside of ContentSidebar.js

fetchMetadataSuccessCallback = ({ editors }: { editors: Array<MetadataEditor> }): void => {
    const { docGenSidebarProps }: Props = this.props;
    const { setDocGenState }: DocGenSidebarProps = docGenSidebarProps;
    
    this.setState({ metadataEditors: editors });

    if (SidebarUtils.canHaveDocGenSidebar(this.props)) {
        setDocGenState(); // internal call to determine value of isDocGenTemplate
    }
};

this should allow the function below to become:

// inside of Sidebar.js

handleDocGenUpdate = (prevProps: Props) => {
    const { docGenSidebarProps, hasDocGen }: Props = this.props;
    const { docGenSidebarProps: prevDocGenSidebarProps }: Props = prevProps;

    const { isDocGenTemplate }: DocGenSidebarProps = docGenSidebarProps;
    const { isDocGenTemplate: prevIsDocGenTemplate }: DocGenSidebarProps = docGenSidebarProps;

    if (hasDocGen && isDocGenTemplate && isDocGenTemplate !== prevIsDocGenTemplate) {
        history.push(`/${SIDEBAR_VIEW_DOCGEN}`);
    }
};

my hope is that the existing logic in ContentSidebar will handle when files changes

[rustam-e]

I didn't use the logic in ContentSidebar because it only fetches metadata in following case:
const canHaveMetadataSidebar = !isFeatureEnabled && SidebarUtils.canHaveMetadataSidebar(this.props);
which is confusing to me since it seems to be the opposite of metadata being enabled. So I didn't want to change the existing logic that would affect metadata tab (since I don't understand it) and created my own.

[rustam-e]

but if it is indeed a mistake then I can try updating that indeed - I raised it with the metadata team

[rustam-e]

I discussed it with @bfoxx1906 and decided t o leave it as it is - the code in the current implementation will be removed once we retrieve information of whether a file is a DocGen template from backend - the logic in ContentSidebar is quite old and affecting state of that component and Metadata sidebar so I'd like to avoid modifying it since I'll have to revert back once the logic is no longer necessary.

[bfoxx1906]

My concerns have been addressed and we confirmed that a lot of the docgen logic will eventually be moved to the backed api. Make sure @tjuanitas 's comments are addressed and we should be good to go.

[rustam-e]

I have added the acknowledgement of the cla agreement - not sure why it's hanging.

[rustam-e]