Add `priority` to `jahiaComponent` definition to break a tie between several matching templates/views

[hduchesne]

Old ticket

Environment and versions used

Jahia 8.2 latest
javascript-modules-engin 0.3.0

Steps to reproduce

In luxe create a content template for jmix:mainResource like this one :

import React from 'react';
import {defineJahiaComponent, Render, useServerContext} from '@jahia/javascript-modules-library';
import {MainLayout} from '../../layouts';

export const MainRessourceDefault = () => {
    const {currentNode} = useServerContext();
    return (
        <MainLayout>
            <Render node={currentNode} view="fullPage"/>
        </MainLayout>

    );
};

MainRessourceDefault.jahiaComponent = defineJahiaComponent({
    nodeType: 'jmix:mainResource',
    name: 'default',
    displayName: 'Default Main Resource',
    componentType: 'template'
});

Current Behavior

This new content template for jmix:mainResource is used prior the content template for luxe:agency (https://github.com/Jahia/luxe-jahia-demo/blob/main/src/server/templates/agency/AgencyDefault.jsx) or any other content type with jmix:mainResource.

To start investigation : https://github.com/Jahia/javascript-modules/blob/6ca44ec37b3f0ca9bd9b37eb7bb8d63af[…]odules/javascript/modules/engine/registrars/ViewsRegistrar.java

Desired Behavior

The jmix:mainResource template should be a fallback. The content template of the mainNodeType should be used prior the one of the mixin.

New component definition property: priority

Works like CSS z-index: the biggest number wins. When not defined, value is 0. Negative numbers can be used to reduce priority.

This decides what template should be rendered when several match for a resource given.

TODO:

• New property in jahiaComponent definition
• Proper JSDoc definition
• Automated tests
• Make MainResource template in Hello World -1 priority + comment

[danielaebenberger]

To be verified/confirmed by @Jahia/team-goat before resolving it.

[Fgerthoffert]

@GauBen to update the description with expected behavior before we start implementation.

[baptistegrimaud]

New optional priority parameter added that can be passed when declaring a component (for both views and templates):

jahiaComponent(
  {
    nodeType: "myns:myView",
    componentType: "view",
    priority: 123,
  },
// rendering here
);

For testing:

• declare multiple views/templates with the same name, applicable on the same node type/mixin, but with different priorities
• make sure the component with the highest priority is used
• you can take a look at javascript-modules-engine/tests/cypress/e2e/ui/priorityOnTemplatesTest.cy.ts and javascript-modules-engine/tests/cypress/e2e/ui/priorityOnViewsTest.cy.ts for more details

[baptistegrimaud]

As discussed with @GauBen , automated tests are enough to validate this change, no manual testing needed.
Closing this task.