From ab172b087fb808e26e2437ebccdeb62464ad3429 Mon Sep 17 00:00:00 2001 From: Leszek Witkowicz Date: Thu, 15 Apr 2021 16:47:05 +0200 Subject: [PATCH 1/4] prepare 4.2.0 release --- CHANGELOG.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 1 + VERSION | 2 +- doc/index.md | 1 + 4 files changed, 53 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2d44f20d2ab..f7c97f538e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,53 @@ +# [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) +- Inbox extensions (#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) + +### Changed +- Usage of maps instead of lists in session management (#3018) +- Improved timestamp logic (#3031) +- Prepared queries for MS SQL, mySQL and pgSQL (#3039, #3050, #3055, #3059, #3060, #3066, #3074, #3078) +- Improved pipeline for `mod_smart_markers` (#3068) +- Unified checks for chat markers (#3080) +- Set `mod_mam_meta.pm.archive_groupchats` to `false` by default (#3082) + +### Fixed +- Creation of `modMucMamFlushed` metric (#3023) +- Starting backend containers for Mac OS X (#3033) +- Minor issues with GitHub Actions (#3045) +- Crash during handover session (#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) + +### Other +- Dependencies update (#3036, #3077) +- Minor documentation improvements (#3043, #3046, #3079) + +## 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) + + # [MongooseIM 4.1.0](https://github.com/esl/MongooseIM/releases/tag/4.1.0) - 2021-02-02 ## Highlights diff --git a/README.md b/README.md index 76dbc935f3c..d339562d8cc 100644 --- a/README.md +++ b/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/) diff --git a/VERSION b/VERSION index ee74734aa22..6aba2b245a8 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -4.1.0 +4.2.0 diff --git a/doc/index.md b/doc/index.md index 5b9148c8fb8..e412799c4f9 100644 --- a/doc/index.md +++ b/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/) From 08280e5d152dc76ec1de6caa6edf58910b644735 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Chrz=C4=85szcz?= Date: Fri, 16 Apr 2021 10:11:29 +0200 Subject: [PATCH 2/4] [skip-ci] Update migration guide for rel-4.2.0 --- doc/migrations/4.1.0_4.2.0.md | 40 +++++++++++++++++++++++++++++++++++ doc/migrations/4.1.0_4.x.x.md | 20 ------------------ mkdocs.yml | 2 +- 3 files changed, 41 insertions(+), 21 deletions(-) create mode 100644 doc/migrations/4.1.0_4.2.0.md delete mode 100644 doc/migrations/4.1.0_4.x.x.md diff --git a/doc/migrations/4.1.0_4.2.0.md b/doc/migrations/4.1.0_4.2.0.md new file mode 100644 index 00000000000..9e259aa8ee9 --- /dev/null +++ b/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. diff --git a/doc/migrations/4.1.0_4.x.x.md b/doc/migrations/4.1.0_4.x.x.md deleted file mode 100644 index 826e0ac2c93..00000000000 --- a/doc/migrations/4.1.0_4.x.x.md +++ /dev/null @@ -1,20 +0,0 @@ -## 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 - -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; -``` diff --git a/mkdocs.yml b/mkdocs.yml index 5dbdebb339a..22bee1626bc 100644 --- a/mkdocs.yml +++ b/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' From 58c57b48e8fbd45887581ad02ecb2d39bf0d756e Mon Sep 17 00:00:00 2001 From: Leszek Witkowicz Date: Fri, 16 Apr 2021 12:07:24 +0200 Subject: [PATCH 3/4] apply comments --- CHANGELOG.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f7c97f538e0..a567828478a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,7 +10,8 @@ ### Added - Documentation for `mod_offline.store_groupchat_messages` option (#2992) -- Inbox extensions (#3067) +- 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 @@ -20,19 +21,19 @@ ### Changed - Usage of maps instead of lists in session management (#3018) - Improved timestamp logic (#3031) -- Prepared queries for MS SQL, mySQL and pgSQL (#3039, #3050, #3055, #3059, #3060, #3066, #3074, #3078) +- 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) -- Set `mod_mam_meta.pm.archive_groupchats` to `false` by default (#3082) ### Fixed - Creation of `modMucMamFlushed` metric (#3023) - Starting backend containers for Mac OS X (#3033) - Minor issues with GitHub Actions (#3045) -- Crash during handover session (#3056) +- 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) @@ -47,6 +48,10 @@ [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 From ab810ca968ca9d543877a94d9b1d5b4534d8e42f Mon Sep 17 00:00:00 2001 From: Leszek Witkowicz Date: Mon, 19 Apr 2021 17:33:33 +0200 Subject: [PATCH 4/4] add #3086 and #3087 to the release --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a567828478a..c7263915e82 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ ### 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) @@ -37,7 +38,7 @@ ### Other - Dependencies update (#3036, #3077) -- Minor documentation improvements (#3043, #3046, #3079) +- 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)