3.0.0 Upgrade Support Thread

[Sebastián Cisneros]

@baris these are the 2 functions that run in the renderHeader and renderFooter hooks

const env = require("./env");
const groups = require.main.require("./src/groups");
const nconf = require.main.require("nconf");
const customTags = require("./customTags");
const helper = require("./helper");
const userDigest = require.main.require("./src/user/digest");

AllPagesBuild.buildOnlyFooter = async function (hookData) {
	const req = hookData.req;
	const res = hookData.res;
	let templateValues = hookData.templateValues;
	const data = hookData.data;
	const uid = req.uid;
	const loggedIn = req.loggedIn;

	return {
		req: req,
		res: res,
		templateValues: templateValues,
		data: data,
	};
};

AllPagesBuild.build = async function (hookData) {
	const req = hookData.req;
	const res = hookData.res;
	let templateValues = hookData.templateValues;
	const data = hookData.data;

	const display_comm_hub =
		typeof nconf.get("display_comm_hub") === "undefined"
			? true
			: nconf.get("display_comm_hub");
	const GW_DS_URL = nconf.get("GW_DS_URL");

	const uid = req.uid;

	const notifications = nconf.get("show_notifications");
	const show_notifications = !!notifications;

	templateValues.loggedIn = req.loggedIn;

	templateValues.env = env;
	templateValues.env.GW_DS_URL = GW_DS_URL;
	templateValues.env.show_notifications = show_notifications;

	templateValues.customTags = customTags.tags;

	templateValues.communityGuidelinesUrl = nconf.get("communityGuidelinesUrl");

	templateValues.countryList = await helper.getAllCountriesUsed(uid);
	
	templateValues.usaStates = await helper.getAllUsStatesUsed(uid);

	//show / hide hub nav item if user belongs to administrators / farmer / pertner / staff group

	templateValues.showHubNavItem = display_comm_hub;

	return {
		req: req,
		res: res,
		templateValues: templateValues,
		data: data,
	};
};

[baris]

You need to return hookData from the filter functions. Change the below

return {
	req: req,
	res: res,
	templateValues: templateValues,
	data: data,
};

to

return hookData;

[Sebastián Cisneros]

@baris Thanks. That fixed the problem. A couple more questions about 1-alerts, 2-composer
1 - about the alerts

in my theme im triggering some alerts like this

(function(config, app, ajaxify, $, templates) {
    'use strict';

    function changeWatching(type, tid, postion, state = 1) {
        const method = state ? 'put' : 'del';
        api[method](`/topics/${tid}/${type}`, {}, () => {
            var message = '';
            if (type === 'follow') {
                message = state ? '[[topic:following_topic.message]]' : '[[topic:not_following_topic.message]]';
            } else if (type === 'ignore') {
                message = state ? '[[topic:ignoring_topic.message]]' : '[[topic:not_following_topic.message]]';
            }

            // From here on out, type changes to 'unfollow' if state is falsy
            if (!state) {
                type = 'unfollow';
            }

            setFollowState(type, tid, postion);

            app.alert({
                alert_id: 'follow_thread',
                message: message,
                type: 'success',
                timeout: 5000,
            });

            $(window).trigger('action:topics.changeWatching', { tid: tid, type: type });
        }, () => {
            app.alert({
                type: 'danger',
                alert_id: 'topic_follow',
                title: '[[global:please_log_in]]',
                message: '[[topic:login_to_subscribe]]',
                timeout: 5000,
            });
        });

        return false;
    }


})(config, app, ajaxify, $, window.templates || null);

maybe something has changed on how alerts works on nodebb v3?

I get this error in console.

Uncaught TypeError: c.alert is not a function
at Ft.<computed>.c.alert.type (nodebb.min.js?v=356i6nfjfq9:8:17119)
at Object.<anonymous> (nodebb.min.js?v=356i6nfjfq9:9:13322)
at rt (nodebb.min.js?v=356i6nfjfq9:59:30032)
at Object.fireWith [as resolveWith] (nodebb.min.js?v=356i6nfjfq9:59:30830)
at ae (nodebb.min.js?v=356i6nfjfq9:62:6108)
at XMLHttpRequest.<anonymous>

2 - composer.
I'm using a customized version of composer-quill. In order to open up the composer modal I use this.

<a href="{relative_path}/compose" component="category/post" id="new_topic" class="gwds-btn size-lg start-discussion" data-ajaxify="false" role="button">
						<span class="label">START A DISCUSSION</span>
					</a>

when cliked on thi sbutton I get this error now

nodebb.min.js?v=356i6nfjfq9:62 Uncaught TypeError: Cannot read properties of null (reading 'querySelector')
at s.handleToggler (nodebb.min.js?v=356i6nfjfq9:62:19960)
at i.enhance (2343.a5b7580e4d0fcdbc1539.min.js:10:951)
at 2343.a5b7580e4d0fcdbc1539.min.js:10:3895

[baris]

app.alert, app.alertError, app.alertSuccess these methods are all removed, you can use the alerts module.

const alerts = await app.require('alerts');
alerts.alert(...);
alerts.error(...);
alerts.success(...);

[Sebastián Cisneros]

This post is deleted!

[baris]

I don't think the quill composer was updated to work with nodebb 3.x

[Sebastián Cisneros]

@baris can you give me a rough list of updates that have been made on nodebb v3 that may have broke composer - quill ? I'm trying to estimate how long it will take me to fix it for nodebb v3 (in case the composer-quill developer is not available to fix it)

[julian]

@Sebastián-Cisneros These are the breaking changes from v2 to v3

https://nodebb.org/blog/migration-guide-for-v3/

[baris]

The biggest change that would effect quill would be the change to sass from less https://github.com/NodeBB/nodebb-plugin-composer-quill/blob/master/plugin.json#L18-L23. The less files are no longer used so those would need to be converted to sass.

[Sebastián Cisneros]

@baris , @julian I have one more question about updagring composer-quill . nodebb-composer-quill like extends from nodebb-composer-default.

"modules": {
		"quill.js": "./node_modules/quill/dist/quill.js",
		"quill-magic-url.js": "./node_modules/quill-magic-url/dist/index.js",
		"quill-emoji.js": "./static/lib/emoji.js",
		"composer.js": "../nodebb-plugin-composer-default/static/lib/composer.js",
		"composer/categoryList.js": "../nodebb-plugin-composer-default/static/lib/composer/categoryList.js",
		"composer/controls.js": "../nodebb-plugin-composer-default/static/lib/composer/controls.js",
		"composer/drafts.js": "../nodebb-plugin-composer-default/static/lib/composer/drafts.js",
		"composer/formatting.js": "../nodebb-plugin-composer-default/static/lib/composer/formatting.js",
		"composer/preview.js": "../nodebb-plugin-composer-default/static/lib/composer/preview.js",
		"composer/resize.js": "../nodebb-plugin-composer-default/static/lib/composer/resize.js",
		"composer/scheduler.js": "../nodebb-plugin-composer-default/static/lib/composer/scheduler.js",
		"composer/tags.js": "../nodebb-plugin-composer-default/static/lib/composer/tags.js",
		"composer/uploads.js": "../nodebb-plugin-composer-default/static/lib/composer/uploads.js",
		"composer/autocomplete.js": "../nodebb-plugin-composer-default/static/lib/composer/autocomplete.js",
		"../admin/plugins/composer-quill.js": "./static/lib/admin.js"
	},

so, when compiling, ./nodebb build I get this error

ERROR in ./node_modules/nodebb-plugin-composer-default/static/lib/composer.js
Module not found: Error: Can't resolve 'composer/post-queue' in '...\nodebb\node_modules\nodebb-plugin-composer-default\static\lib'
Did you mean './composer/post-queue'?
Requests that should resolve in the current directory need to start with './'.
Requests that start with a name are treated as module requests and resolve within module directories (build/public/src/modules, build/public/src, node_modules, node_modules/nodebb-plugin-mentions/node_modules, node_modules/nodebb-widget-essentials/node_modules, node_modules/nodebb-rewards-essentials/node_modules, node_modules/nodebb-plugin-emoji/node_modules, node_modules/nodebb-plugin-emoji-android/node_modules, node_modules/nodebb-plugin-dbsearch/node_modules, node_modules/nodebb-plugin-community-payload/node_modules, node_modules/nodebb-plugin-greenwave-comments-api/node_modules, node_modules/nodebb-plugin-greenwave-tag-follow/node_modules, node_modules/nodebb-plugin-greenwave-update-user-api/node_modules, node_modules/nodebb-plugin-payload-api/node_modules, node_modules/nodebb-plugin-s3-uploads-updated/node_modules, node_modules/nodebb-widget-search-bar/node_modules, node_modules/nodebb-plugin-composer-quill/node_modules, node_modules/nodebb-plugin-email-helper/node_modules, node_modules/nodebb-theme-greenwave-hub/node_modules, node_modules/nodebb-plugin-composer-default/node_modules).
If changing the source code is not an option there is also a resolve options called 'preferRelative' which tries to resolve these kind of requests in the current directory too.

ERROR in ./node_modules/nodebb-plugin-composer-default/static/lib/composer/categoryList.js 100:2-111:4
Module not found: Error: Can't resolve 'composer/post-queue' in '...\nodebb\node_modules\nodebb-plugin-composer-default\static\lib\composer'

I think some of the nodebb-composer-default updates to work with nodebb v3 changed something related to the error that I just posted above. If you have an aidea what it can be, please let me know. I may be able to fix it.

On another hand, I've replaced nodebb-composer-default v10+ that is updated for nodebb v3 with the latest version of nodebb-composer-default that worked with my install (this is nodebb-plugin-composer-default v9.2.5 https://github.com/NodeBB/nodebb-plugin-composer-default/tree/v9.2.5 ) and it works, nodebb-compose-quill complies and works. But maybe I need some of the updates of nodebb-composer-default v10+, not sure. IIt would be better to have the most updated versions working. Thanks!

[baris]

@Sebastián-Cisneros maybe you are missing this file in your composer-default plugin?

It was added in nodebb 3.4.0 https://github.com/NodeBB/NodeBB/issues/11949

So add that file into plugin.json of quill,

"composer/post-queue.js": "../nodebb-plugin-composer-default/static/lib/composer/post-queue.js",