Category Banners component not compatible with 3.2.0.beta2

simonk · October 24, 2023, 9:33am

I updated the category-banners component yesterday on a site running 3.2.0.beta2 and the banners no longer appear. I think it is because of this change:

In particular, I think this change causes the component to require API version 1.15.0, whereas the latest beta is only at 1.14.0.

From a quick look, I can see that the component requires 1.13.0 for renderInOutlet, but I don’t think it should require 1.14.0 or 1.15.0, should it?

pfaffman · October 24, 2023, 10:19am

Have you done a rebuild lately? I suspect that you need a new base image.

simonk · October 24, 2023, 10:37am

Thank you very much for the reply. I’m sure you are correct that the component works on the latest tests-passed version, but I prefer to stick to the beta releases when possible. My post was partly meant to be a warning to anyone else who sticks to the betas like me, and partly a hint to the team that perhaps the API version requirement for this component is more strict than it needs to be.

I think it’s a bug because the .discourse-compatibility file specifically lists revision 1398eeeff550c1da186a47b6d3878d3230f62340 as working with 3.2.0.beta2, and I don’t think there’s any way it can.

tgxworld · October 26, 2023, 6:20am

Are you running a particular version of a beta tag? If so, can you let me know which beta tag you are on so that I can have a look?

In the compatibility file we have < 3.2.0.beta2: 1398eeeff550c1da186a47b6d3878d3230f62340 which states the any Discourse version smaller than 3.2.0.beta2 will pin the theme to the 1398eeeff550c1da186a47b6d3878d3230f62340 commit hash.

simonk · October 26, 2023, 9:27am

Hi @tgxworld, thank you for the reply.

Yes, I’m running the v3.2.0.beta2 tag (be04154838):

The plugin API version supported by this release is 1.14.0:

github.com

discourse/discourse/blob/v3.2.0.beta2/app/assets/javascripts/discourse/app/lib/plugin-api.js#L138


      
          } from "discourse-common/lib/icon-library";
          import I18n from "I18n";
          import { CUSTOM_USER_SEARCH_OPTIONS } from "select-kit/components/user-chooser";
          import { modifySelectKit } from "select-kit/mixins/plugin-api";
          
          // If you add any methods to the API ensure you bump up the version number
          // based on Semantic Versioning 2.0.0. Please update the changelog at
          // docs/CHANGELOG-JAVASCRIPT-PLUGIN-API.md whenever you change the version
          // using the format described at https://keepachangelog.com/en/1.0.0/.
          
          export const PLUGIN_API_VERSION = "1.14.0";
          
          // This helper prevents us from applying the same `modifyClass` over and over in test mode.
          function canModify(klass, type, resolverName, changes) {
            if (!changes.pluginId) {
              // eslint-disable-next-line no-console
              console.warn(
                consolePrefix(),
                "To prevent errors in tests, add a `pluginId` key to your `modifyClass` call. This will ensure the modification is only applied once."
              );
              return true;

Revision 1398eeeff550c1da186a47b6d3878d3230f62340 of discourse-category-banners requires API version 1.15.0, which is not available in v3.2.0.beta2

github.com

discourse/discourse-category-banners/blob/1398eeeff550c1da186a47b6d3878d3230f62340/javascripts/discourse/initializers/discourse-category-banners.js#L4


      
          import { apiInitializer } from "discourse/lib/api";
          import CategoryBanner from "../components/category-banner";
          
          export default apiInitializer("1.15.0", (api) => {
            api.renderInOutlet(settings.plugin_outlet, CategoryBanner);
          });

API version 1.15.0 was added in this commit:

github.com/discourse/discourse

DEV: Add new experimental admin UI route and sidebar (#23952)

committed 04:23AM - 19 Oct 23 UTC

martin-brennan

+606 -23

This commit adds a new admin UI under the route `/admin-revamp`, which is only …accessible if the user is in a group defined by the new `enable_experimental_admin_ui_groups` site setting. It also adds a special `admin` sidebar panel that is shown instead of the `main` forum one when the admin is in this area. ![image](https://github.com/discourse/discourse/assets/920448/fa0f25e1-e178-4d94-aa5f-472fd3efd787) We also add an "Admin Revamp" sidebar link to the community section, which will only appear if the user is in the setting group: ![image](https://github.com/discourse/discourse/assets/920448/ec05ca8b-5a54-442b-ba89-6af35695c104) Within this there are subroutes defined like `/admin-revamp/config/:area`, these areas could contain any UI imaginable, this is just laying down an initial idea of the structure and how the sidebar will work. Sidebar links are currently hardcoded. Some other changes: * Changed the `main` and `chat` panels sidebar panel keys to use exported const values for reuse * Allowed custom sidebar sections to hide their headers with the `hideSectionHeader` option * Add a `groupSettingArray` setting on `this.siteSettings` in JS, which accepts a group site setting name and splits it by `|` then converts the items in the array to integers, similar to the `_map` magic for ruby group site settings * Adds a `hidden` option for sidebar panels which prevents them from showing in separated mode and prevents the switch button from being shown --------- Co-authored-by: Krzysztof Kotlarek <kotlarek.krzysztof@gmail.com>

…which has not been released as a beta yet.

To resolve this, I think that the theme component could just require API version 1.13.0 instead (the one that introduced api.renderInOutlet), which is part of v3.2.0.beta2.

github.com/discourse/discourse

FEATURE: Introduce `api.renderInOutlet` (#23719)

committed 10:56AM - 05 Oct 23 UTC

davidtaylorhq

+92 -15

Until now, plugins/themes had to follow very specific directory structures to se…t up plugin outlet connectors. This commit introduces a new `api.renderInOutlet` API which makes things much more flexible. Any Ember component definition can be passed to this API, and will then be rendered into the named outlet. For example: ```javascript import MyComponent from "discourse/plugins/my-plugin/components/my-component"; api.renderInOutlet('user-profile-primary', MyComponent); ``` When using this API alongside the gjs file format, components can be defined inline like ```javascript api.renderInOutlet('user-profile-primary', <template>Hello world</template>); ```

tgxworld · October 26, 2023, 11:36pm

@simonk Thank you for doing the digging. This is a bug on our end and I have fixed this in

simonk · October 27, 2023, 9:33am

@tgxworld thank you! I can confirm that the component is working again on my site running v3.2.0.beta2

I wonder if you should edit the .discourse-compatibility file though. At the moment, anyone running versions between 3.1.999 and 3.2.0.beta2 will be given a version that depends on plugin API version 1.15.0. They should probably be pinned to 65a2cfc43fb5f6ffd2f8db3888552594ed21c501 instead (the commit before the refactor).

JammyDodger · October 28, 2023, 7:00am

This topic was automatically closed after 20 hours. New replies are no longer allowed.

Topic		Replies	Views
Category Banners Theme component official , category-banners	64	45420	October 20, 2024
3.2.0.beta4: easier access to chat threads, chat mobile redesign, experimental admin sidebar, and more Announcements release-notes	1	1815	January 8, 2024
Add Category Column Theme component official , category-column	14	6910	December 5, 2024
Discourse 2.5.0.beta4 Release Notes Announcements release-notes	1	2988	May 4, 2020
3.3.0.beta1: Discourse Discover opt in, Hot topics page, "It's illegal" flag reason, and more! Announcements release-notes	1	1942	March 15, 2024

Category Banners component not compatible with 3.2.0.beta2

Related topics