Merge pull request #3084 from esl/rel-4.2.0

Prepare MongooseIM 4.2.0 release

CHANGELOG.md

@@ -1,3 +1,59 @@
+# [MongooseIM 4.2.0](https://github.com/esl/MongooseIM/releases/tag/4.2.0) - 2021-04-20
+
+## Highlights
+
+- Prepared queries introduced
+- Inbox extensions
+- Miscellaneous enhancements & improvements
+
+## All changes
+
+### Added
+- Documentation for `mod_offline.store_groupchat_messages` option (#2992)
+- Support of MS SQL and MySQL in `mod_auth_token` (#3059)
+- Inbox extensions to set entries as archived, muted or read (#3067)
+- `mod_domain_isolation` module to limit message passing between domains (#3070)
+
+### Removed
+- Usage of deprecated `http_uri` in `ejabberd_auth_http` and `mod_muc_room` modules (#3026)
+- Config reload functionality with the flat config format (#3030)
+- Outdated and unsupported `azuresql.sql` file (#3086)
+
+### Changed
+- Usage of maps instead of lists in session management (#3018)
+- Improved timestamp logic (#3031)
+- Prepared queries for MS SQL, MySQL and PostgreSQL (#3039, #3050, #3055, #3059, #3060, #3066, #3074, #3078)
+- Improved pipeline for `mod_smart_markers` (#3068)
+- Unified checks for chat markers (#3080)
+
+### Fixed
+- Creation of `modMucMamFlushed` metric (#3023)
+- Starting backend containers for Mac OS X (#3033)
+- Minor issues with GitHub Actions (#3045)
+- Crash during session handover (#3056)
+- Type declaration in `mod_muc_light.hrl` (#3057)
+- Test summary is no longer printed when CT directory is not created (#3069)
+- Explicit `preset_not_found` error when running tests with nonexistent preset (#3072)
+- Set `mod_mam_meta.pm.archive_groupchats` to `false` by default (#3082)
+
+### Other
+- Dependencies update (#3036, #3077)
+- Minor documentation improvements (#3043, #3046, #3079, #3087)
+
+## Commits, merged PRs and closed issues
+- [List of merged PRs](https://github.com/esl/MongooseIM/pulls?q=is%3Apr+is%3Amerged+milestone%3A4.2.0)
+
+- [List of closed issues](https://github.com/esl/MongooseIM/issues?q=is%3Aissue+is%3Aclosed+closed%3A2021-02-04..2021-04-20+)
+
+- [Repository history for this release](https://github.com/esl/MongooseIM/graphs/contributors?from=2021-02-04&to=2021-04-20&type=c)
+
+[List of merged PRs based on merge date]: # (https://github.com/esl/MongooseIM/pulls?utf8=%E2%9C%93&q=is%3Apr%20base%3Amaster%20merged%3A%222021-02-04..2021-04-20%22%20sort%3Acreated-asc%20)
+
+## Special thanks to our contributors:
+- Inbox extensions are sponsored by [Beekeeper](https://www.beekeeper.io/)
+- [@antivista](https://github.com/antivista) For the documentation supplement (#2992)
+- [@imcyee](https://github.com/imcyee) For fixing handover crash (#3056)
+
 # [MongooseIM 4.1.0](https://github.com/esl/MongooseIM/releases/tag/4.1.0) - 2021-02-02
 
 ## Highlights

README.md

@@ -61,6 +61,7 @@ Check out our test results:
 Up-to-date documentation for the MongooseIM master branch can be found on ReadTheDocs: [https://esl.github.io/MongooseDocs/latest/](https://esl.github.io/MongooseDocs/latest/).
 
 Latest releases:
+* [4.2.0](https://esl.github.io/MongooseDocs/4.2.0/)
 * [4.1.0](https://esl.github.io/MongooseDocs/4.1.0/)
 * [4.0.1](https://esl.github.io/MongooseDocs/4.0.1/)
 * [3.7.1](https://esl.github.io/MongooseDocs/3.7.1/)

VERSION

@@ -1 +1 @@
-4.1.0
+4.2.0

doc/index.md

@@ -79,6 +79,7 @@ Check out our test results:
 See the documentation for the latest releases:
 
 * [Master](https://esl.github.io/MongooseDocs/latest/)
+* [4.2.0](https://esl.github.io/MongooseDocs/4.2.0/)
 * [4.1.0](https://esl.github.io/MongooseDocs/4.1.0/)
 * [4.0.1](https://esl.github.io/MongooseDocs/4.0.1/)
 * [3.7.1](https://esl.github.io/MongooseDocs/3.7.1/)

doc/migrations/4.1.0_4.2.0.md

@@ -0,0 +1,40 @@
+## Minor changes in the `TOML` config format
+
+* The `pgsql_users_number_estimate` option was moved to [`auth.rdbms.users_number_estimate`](../../authentication-methods/rdbms#authrdbmsusers_number_estimate). The new option supports PostgreSQL and MySQL.
+
+## DB migrations
+
+### New inbox features
+
+Inbox now implements new functionality (see [inbox](../open-extensions/inbox.md)), but this required adding new columns to the DB. If you're using inbox, please update the tables as follows:
+
+For Postgres or MySQL:
+```sql
+ALTER TABLE inbox
+  ADD COLUMN archive BOOLEAN DEFAULT false,
+  ADD COLUMN muted_until BIGINT DEFAULT 0;
+```
+For MSSQL:
+```sql
+ALTER TABLE inbox
+  ADD COLUMN archive TINYINT DEFAULT 0,
+  ADD COLUMN muted_until BIGINT DEFAULT 0;
+```
+
+### Archived groupchat messages in `mod_mam`
+
+The [`archive_groupchats`](../../modules/mod_mam#modulesmod_mam_metapmarchive_groupchats) option is now set to `false` by default, as documented.
+Before the change, the private message (PM) archive stored incoming groupchat messages as well, contrary to the documentation.
+After the upgrade you can manually remove those messages from the database.
+For example, when the MUC domain is `muc.localhost` and `rdbms_message_format` has the default value `internal`, one can remove such messages with the following query:
+
+```sql
+DELETE FROM mam_message
+  WHERE direction = 'I' AND remote_bare_jid LIKE 'muc.localhost:%';
+```
+
+This can be a heavy operation and it needs to be done with caution.
+
+### Using `mod_auth_token` with MySQL and MS SQL
+
+The [`mod_auth_token`](../../modules/mod_auth_token) module supports MySQL and MS SQL now. To use this functionality, you need to create the `auth_token` table with the query which you can find in `priv/mysql.sql` and `priv/mssql2012.sql`, respectively.

mkdocs.yml

@@ -51,7 +51,7 @@ nav:
       - '3.7.0 to 4.0.0': 'migrations/3.7.0_4.0.0.md'
       - '4.0.0 to 4.0.1': 'migrations/4.0.0_4.0.1.md'
       - '4.0.1 to 4.1.0': 'migrations/4.0.1_4.1.0.md'
-      - '4.1.0 to 4.x.x': 'migrations/4.1.0_4.x.x.md'
+      - '4.1.0 to 4.2.0': 'migrations/4.1.0_4.2.0.md'
       - 'MAM MUC migration helper': 'migrations/jid-from-mam-muc-script.md'
   - Platform:
       - 'Contributions to ecosystem': 'Contributions.md'