Help with my Custom Function

Teemberland

Hi, this works in version 2.x, but I can't seem to make it work in Harmony v3.

library.js

library.actionTopicDevCheck = async function (hookData) {
  const isInDevGroup = await groups.isMember(hookData.data.uid, 'DEVS');
  if (isInDevGroup) {
    await topics.setTopicField(hookData.post.topic.tid, 'postedInByDeveloper', isInDevGroup);
  }
};

plugin.json

{
  "id": "nodebb-theme-harmony",
  "hooks": [
	{ "hook": "static:app.load", "method": "init" },
	{ "hook": "filter:admin.header.build", "method": "addAdminNavigation" },
	{ "hook": "filter:widgets.getAreas", "method": "defineWidgetAreas" },
	{ "hook": "filter:config.get", "method": "getThemeConfig" },
	{ "hook": "filter:settings.get", "method": "getAdminSettings"},
	{ "hook": "filter:user.saveSettings", "method": "saveUserSettings" },
	{ "hook": "filter:user.profileMenu", "method": "addProfileItem" },
	{ "hook": "filter:middleware.renderHeader", "method": "filterMiddlewareRenderHeader" },
	{ "hook": "filter:middleware.render", "method": "removeFinalBreadcrumb" },
	{ "hook": "action:topic.reply", "method": "actionTopicDevCheck" },
       { "hook": "action:topic.post", "method": "actionTopicDevCheck" }
  ],
  "scripts": [
	"public/harmony.js"
  ],
  "modules": {
	"../admin/plugins/harmony.js": "public/admin.js",
	"../client/account/theme.js": "public/settings.js"
  },
  "staticDirs": {
	"inter": "node_modules/@fontsource/inter/files",
	"poppins": "node_modules/@fontsource/poppins/files"
  },
  "languages": "languages"
}

topic_list.tpl

{{{ if topics.postedInByDeveloper }}}
<div class="topic-badge"><a href="{config.relative_path}/groups/devs"><span class="topic-sds">DEV REPLY</span></a></div>
{{{ end }}}

<baris>

Did you check if actionTopicDevCheck is being triggered?

Teemberland

@baris what is the best way to debug that? Will that show in browser console?

<baris>

No you need to add a console.log in library.actionTopicDevCheck and then check nodebb logs on the server side.

Teemberland

@baris got it. let me try that

Teemberland

@baris the function is not being triggered. Am I missing something in my code?

<baris>

If it's not triggered double check if the plugin is active and there are no error messages.

Put a console.log in { "hook": "static:app.load", "method": "init" }, and see if that is triggered. That gets called during startup.

Teemberland

@baris I can see my console log being called in library.init.

I don't remember 'activating' our custom function in v2 before. And I don't see any error messages from our custom function in the log file.

These hooks haven't change right?

action:topic.reply
action:topic.post

<baris>

action:topic.post and action:topic.reply hasn't changed in a long while so they should work. When you make a change to plugin.json you need to restart nodebb though so it picks up the changes.

Teemberland

@baris yup, I did restart a few times, but the function is still not triggering.

EDIT:

It's triggering now. I added a new user to the group, and when I create a new post using the new user, it triggered my function. I guess the function does not trigger for old posts?

<baris>

Those hooks only fire when a new post/topic is made.

oplik0

Note that hooks are generally for reacting to (or modifying) events.
Some may happen during startup, but usually the function from a hook is triggered at some point during some request to NodeBB.

If you want to run something on existing content after installing a plugin you might want to look into upgrades - functions that run on startup only once, saved into database afterwards to avoid re-running them. See for example the dbsearch plugin changing the MongoDB schema: https://github.com/barisusakli/nodebb-plugin-dbsearch/ (tl;dr you just need a module that exports what's needed to plugin.json in the upgrades array. You can see the format in the upgrades/dbsearch_change_mongodb_schema.js.).

You can obviously also try doing something similar yourself in e.g. static:app.load, but why bother when NodeBB already has a mechanism for it

<baris>

@oplik0 yeah and if you don't want an upgrade script and just want to run some code that connects to the database to modify stuff or create reports etc. you can run custom script. These go in the nodebb folder and can be executed by node my_custom_script.js. Below is a template that we use frequently.

/* globals require, console, process */

'use strict';

const nconf = require('nconf');

nconf.file({
	file: 'config.json',
});

nconf.defaults({
	base_dir: __dirname,
	views_dir: './build/public/templates',
	upload_path: 'public/uploads',
});

const db = require('./src/database');

db.init(async (err) => {
	if (err) {
		console.log(`NodeBB could not connect to your database. Error: ${err.message}`);
		process.exit();
	}

	await doSomethingUseful();
	console.log('done');
	process.exit();
});

async function doSomethingUseful() {
	console.log('global object', await db.getObject('global'));
}