Community

1.19.0 Breaking Changes

NodeBB Development
  • julianJ

    Themes should no longer rely on showHidden property in all user account pages (profile/edit/etc.)

    It has been replaced with canEdit (which has been around for quite awhile), whose logic is identical. showHidden will be removed in this version of NodeBB.

    Issues · NodeBB/NodeBB

    Node.js based forum software built for the modern web - Issues · NodeBB/NodeBB

    favicon

    GitHub (github.com)

    Plugins

    2
  • julianJ julian pinned this topic on
  • barisB

    Removals

    socket.emit('admin.categories.create') removed, use POST /api/v3/categories
    socket.emit('admin.categories.purge') removed, use DELETE /api/v3/categories/:cid
    socket.emit('admin.categories.update') removed, use PUT /api/v3/categories/:cid
    socket.emit('admin.categories.setPrivilege') removed, use PUT /api/v3/categories/:cid/privileges/:privilege
    socket.emit('admin.categories.getAll') removed, use GET /api/admin/manage/categories
    socket.emit('admin.categories.getPrivilegeSettings') removed use GET /api/v3/categories/:cid/privileges
    socket.emit('admin.categories.setPrivilege') removed use PUT /api/v3/categories/:cid/privileges/:privilege

    socket.emit('admin.groups.create') removed use POST /api/v3/groups
    socket.emit('admin.groups.join') removed use PUT /api/v3/groups/:slug/membership/:uid
    socket.emit('admin.groups.leave') removed use DELETE /api/v3/groups/:slug/membership/:uid
    socket.emit('admin.groups.update') removed use PUT /api/v3/groups/:slug

    socket.emit('admin.user.deleteUsers') removed use DELETE /api/v3/users/:uid/account
    socket.emit('admin.user.deleteUsersContent') removed use DELETE /api/v3/users/:uid/content
    socket.emit('admin.user.deleteUsersAndContent') removed use DELETE /api/v3/users or DELETE /api/v3/users/:uid

    socket.emit('admin.uploads.delete') removed use DELETE /api/v3/files

    socket.emit('posts.reply') removed use POST /api/v3/topics/:tid
    socket.emit('posts.getPost') removed user GET /api/v3/posts/:pid
    socket.emit('posts.delete') removed use DELETE /api/v3/posts/:pid/state
    socket.emit('posts.restore') removed use PUT /api/v3/posts/:pid/state
    socket.emit('posts.purge') removed use DELETE /api/v3/posts/:pid
    socket.emit('posts.getDiffs') removed use GET /api/v3/posts/:pid/diffs
    socket.emit('posts.showPostAt') removed use GET /api/v3/posts/:pid/diffs/:since
    socket.emit('posts.restoreDiff') removed use PUT /api/v3/posts/:pid/diffs/:since
    socket.emit('posts.edit') removed use PUT /api/v3/posts/:pid
    socket.emit('posts.bookmark') removed use PUT /api/v3/posts/:pid/bookmark
    socket.emit('posts.unbookmark') removed use DELETE /api/v3/posts/:pid/bookmark
    socket.emit('posts.movePost') removed use PUT /api/v3/posts/:pid/move
    socket.emit('posts.movePosts') removed use PUT /api/v3/posts/:pid/move
    socket.emit('posts.upvote') removed use PUT /api/v3/posts/:pid/vote
    socket.emit('posts.downvote') removed use PUT /api/v3/posts/:pid/vote
    socket.emit('posts.unvote') removed use DELETE /api/v3/posts/:pid/vote

    socket.emit('topics.post') removed use POST /api/v3/topics
    socket.emit('topics.search') removed use GET /api/search
    socket.emit('topics.getTopic') removed use GET /api/v3/topics/:tid
    socket.emit('topics.delete') removed use DELETE /api/v3/topics/state
    socket.emit('topics.restore') removed use PUT /api/v3/topics/state
    socket.emit('topics.purge') removed use DELETE /api/v3/topics
    socket.emit('topics.lock') removed use PUT /api/v3/topics/lock
    socket.emit('topics.unlock') removed use DELETE /api/v3/topics/lock
    socket.emit('topics.pin') removed use PUT /api/v3/topics/pin
    socket.emit('topics.unpin') removed use DELETE /api/v3/topics/pin
    socket.emit('topics.follow') removed use PUT /api/v3/topics/:tid/follow
    socket.emit('topics.changeWatching') removed use PUT/DELETE /api/v3/topics/:tid/(follow|ignore)

    socket.emit('groups.join') removed use PUT /api/v3/groups/:slug/membership/:uid
    socket.emit('groups.leave') removed use DELETE /api/v3/groups/:slug/membership/:uid
    socket.emit('groups.grant') removed use PUT /api/v3/groups/:slug/ownership/:uid
    socket.emit('groups.rescind') removed use DELETE /api/v3/groups/:slug/ownership/:uid
    socket.emit('groups.update') removed use PUT /api/v3/groups/:slug
    socket.emit('groups.create') removed use POST /api/v3/groups
    socket.emit('groups.delete') removed use DELETE /api/v3/groups

    socket.emit('flags.create') removed use POST /api/v3/flags
    socket.emit('flags.update') removed use PUT /api/v3/flags/:flagId
    socket.emit('flags.appendNote') removed use POST /api/v3/flags/:flagId/notes
    socket.emit('flags.deleteNote') removed use DELETE /api/v3/flags/:flagId/notes/:datetime

    socket.emit('user.exists') removed use HEAD /api/v3/users/bySlug/:userslug AND HEAD /api/v3/groups/:slug
    socket.emit('user.deleteAccount') removed use DELETE /api/v3/users/:uid/account
    socket.emit('user.follow') removed use POST /api/v3/users/follow
    socket.emit('user.unfollow') removed use DELETE /api/v3/users/unfollow
    socket.emit('user.saveSettings') removed use PUT /api/v3/users/:uid/settings
    socket.emit('user.search') removed use GET /api/users
    socket.emit('user.changePicture') removed use PUT /api/v3/users/:uid/picture
    socket.emit('user.changeUsernameEmail') removed use PUT /api/v3/users/:uid
    socket.emit('user.updateProfile') removed use PUT /api/v3/users/:uid
    socket.emit('user.changePassword') removed use PUT /api/v3/users/:uid/password
    socket.emit('user.setTopicSort') removed use PUT /api/v3/users/:uid/settings
    socket.emit('user.setCategorySort') removed use PUT /api/v3/users/:uid/settings
    socket.emit('user.banUsers') removed use PUT /api/v3/users/:uid/ban
    socket.emit('user.unbanUsers') removed use DELETE /api/v3/users/:uid/ban

    socket.emit('categories.getCategory') removed use GET /api/v3/categories/:cid

    socketHelpers.setDefaultPostData removed use apiHelpers.setDefaultPostData

    socketTopics.loadMoreSortedTopics removed use infinitescroll.loadXHR
    socketTopics.loadMoreFromSet removed use infinitescroll.loadXHR

    Deprecations

    app.alert is deprecated use alerts.alert from alerts module
    app.alertError is deprecated use alerts.error from alerts module
    app.alertSuccess is deprecated use alerts.success from alerts module
    app.removeAlert is deprecated use alerts.remove from alerts module
    app.logout is deprecated use logout module directly. ie require(['logout'], function (logout) { logout() });
    app.openChat is deprecated use chat.openChat from chat module.
    app.newChat is deprecated use chat.newChat from chat module.
    app.enableTopicSearch is deprecated use search.enableQuickSearch from search module.
    app.handleSearch is deprecated use search.init from search module.
    app.prepareSearch is deprecated use search.showAndFocusInput from search module.

    2
  • julianJ

    Some custom themes may introduce additional navigation bars at the top of the page, above the NodeBB header menu.

    Persona included code that calculated the height of the header menu and adjusted #panel to start just below it, but it did not account for cases where the header menu is not at the top of the page.

    Refactor panel padding calculation to make it simpler for themes · Issue #10023 · NodeBB/NodeBB

    The panel padding calculation right now is a simple calculation of the header's height, but it needs to also take into account the header's vertical position in the viewport. Themes often add additional menus on top of the NodeBB header,...

    favicon

    GitHub (github.com)

    Updated Persona code will do so in v1.19.0 going forward, so any custom themes that use CSS overrides to compensate will need a revisit.

    2
  • barisB

    action:category.loaded will not fire when topics are loaded via infinite scroll on category page. use action:topics.loaded instead

    breaking: remove action:category.loaded, use action:topics.loading · NodeBB/[email protected]

    Node.js based forum software built for the modern web - breaking: remove action:category.loaded, use action:topics.loading · NodeBB/[email protected]

    favicon

    GitHub (github.com)

    0
  • julianJ

    Pages starting with /admin/plugins or /api/v3/admin/plugins route prefixes no longer need to call middleware.admin.checkPrivileges or do their own administrative checks. This is now automatically done.

    refactor: use routePrefixMap instead of routeRegexpMap, +tests by julianlam · Pull Request #10035 · NodeBB/NodeBB

    Currently tests fail because privilege pages resolve if passed garbage... hmm

    favicon

    GitHub (github.com)

    However, this could be considered breaking if you had a page with a route starting with /admin/plugins/, and expect to have full access to it from non-admins.

    0
  • barisB

    middleware.authenticate removed, page and API routes are now automatically authenticated via setup(Page|API)Route. Use middleware.authenticateRequest (if not using route helper) and middleware.ensureLoggedIn instead.

    middleware.authenticateOrGuest has been renamed, use middleware.authenticateRequest instead

    breaking: remove deprecated user middlewares · NodeBB/[email protected]

    Node.js based forum software built for the modern web - breaking: remove deprecated user middlewares · NodeBB/[email protected]

    favicon

    GitHub (github.com)

    1
  • barisB

    Topics.getTopicPosts takes a topic object as first parameter.

    breaking: remove getTopicPosts(tid, ...) usage · NodeBB/[email protected]

    Node.js based forum software built for the modern web - breaking: remove getTopicPosts(tid, ...) usage · NodeBB/[email protected]

    favicon

    GitHub (github.com)

    0
  • S sharonyue referenced this topic on
  • julianJ

    fix: move authenticateRequest before interstitial and maintenance mod… · NodeBB/[email protected]

    Node.js based forum software built for the modern web - fix: move authenticateRequest before interstitial and maintenance mod… · NodeBB/[email protected]

    favicon

    GitHub (github.com)

    The commit associated with this issue changes the order of middlewares across all routes using setup*Route helpers.

    This sounds serious, but in practice the only thing this affects is that prior to the change, all api requests using bearer token were automatically refused if the site was in maintenance mode. Now, just as admins are able to access the site during maintenance mode, admins can make bearer call authenticated API calls as well.

    0
  • barisB

    Tags allow % character now, themes will need to be updated to use tags.valueEncoded instead of tags.valueEscaped

    allow % in tags · Issue #10135 · NodeBB/NodeBB

    currently breaks the url to the tag page when allowed

    favicon

    GitHub (github.com)

    See changes in persona to update your custom theme https://github.com/NodeBB/nodebb-theme-persona/commit/6aada9127865ddc1cbaf8cd5f548ebc78f7bf90a

    3
  • julianJ julian unpinned this topic on

Suggested Topics

  • barisB

    1.13.0 Breaking Changes

    NodeBB Development
    6 Votes
    5 Posts
    910 Views
    D

    Apparently the Calendar Plugin:

    nodebb-plugin-calendar
    Calendar and events for NodeBB

    Installed 1.0.0-alpha.50 | Latest 1.0.0-alpha.50

    Does not work with 1.13.0

    Can someone please update it?

  • barisB

    1.10.0 Breaking Changes

    NodeBB Development
    1 Votes
    3 Posts
    2377 Views
    attisA

    Hi,
    I think I have discovered another breaking change that you didn't mention, though it is probably super-niche.

    This commit:

    closes #6553 · NodeBB/[email protected]

    Node.js based forum software built for the modern web - closes #6553 · NodeBB/[email protected]

    favicon

    GitHub (github.com)
    broke our custom SSO plugin. The result was that after successfully logging in our external identity provider and being redirected to our Forum's callback endpoint, I was ending up not logged in (the button in the header still said "Log in") and stuck on /register/complete roadblock. It looked like our Passport strategy verify callback, that parses output from the identity provider and fetches user data via OAuth2 was not invoked at all.

    It turns out that the changes in this commit don't play well together with passport-oauth2 (https://github.com/jaredhanson/passport-oauth2) internal ability to protect against CSRF (which we were using). This strategy was already using state parameter to pass its own CSRF token. I don't have more time to investigate but I suspect things shipwrecked when NodeBB overwrote the state parameter with its own CSRF token.

    Turning off passport-oauth2 internal CSRF protection (by removing state: true from its options) fixed the issue.

  • barisB

    0.7.0 Breaking Changes

    NodeBB Development
    4 Votes
    13 Posts
    7124 Views
    psychobunnyP

    I want to escape by default, to prevent accidental XSS. If you intentionally want to allow scripts then you should use double curly brackets

    I think its something I would rather break today than worry about it in future

  • barisB

    action:topic.save, action:topic.restore, action:topic.edit changes

    NodeBB Development
    0 Votes
    1 Posts
    1379 Views
    barisB

    If you have any plugins that use action:topic.save, action:topic.restore or action:topic.edit please read below on the changes coming in 0.6.0. If you have any questions about how to update to the new hooks please feel free to ask.

    The parameter passed to all three hooks has been changed from a topic id to a topicData object.

    plugins.fireHook('action:topic.save', topicData);
    plugins.fireHook('action:topic.restore', topicData);
    plugins.fireHook('action:topic.edit', topicData);

    topicData object contains at least the following data.

    { tid: 3, title: 'test topic', mainPid: 5 }
  • julianJ

    Plugin Developers!! Read this re: v0.6.0 Breaking changes

    NodeBB Development
    2 Votes
    17 Posts
    6579 Views
    julianJ

    I correctly assumed (and this has been validated through actual plugin upgrades) that the latest hash in npm points to the most recently published version, and not the highest version.

    That is, given your plugin nodebb-plugin-example

    If v1.0.0 is compatible with v0.5.4 If v1.1.0 is compatible only with v0.6.0 The latter is published first A user typing npm install nodebb-plugin-example will receive v1.0.0 of the plugin, irrespective of what NodeBB version he/she is running, even though v1.1.0 is technically newer

    Now, special note: The NodeBB Package Manager doesn't do this. When the ACP calls nbbpm to request a suggested package, we query npm for the plugin data, and sort the versions before checking compatibility, so this issue is moot.

Copyright © 2023 NodeBB | Contributors