Use foldhash in ExtractMap<K, V> within model/cache instead of std's ` hasher

.github/labeler.yml

@@ -1,7 +1,5 @@
 ci:
   - .github/**/*
-command_attr:
-  - command_attr/**/*
 examples:
   - examples/**/*
 builder: 

.github/workflows/ci.yml

@@ -3,8 +3,8 @@ name: CI
 on: [push, pull_request]
 
 env:
-  rust_min: 1.74.0
-  rust_nightly: nightly-2024-03-09
+  rust_min: 1.82.0
+  rust_nightly: nightly-2024-11-01
 
 jobs:
   test:
@@ -26,7 +26,9 @@ jobs:
           - no cache
           - no gateway
           - unstable Discord API features
-          - simd-json
+          - zlib compression
+          - zstd compression
+          - zlib and zstd compression
 
         include:
           - name: beta
@@ -38,22 +40,26 @@ jobs:
           - name: no default features
             features: " "
           - name: no cache
-            features: builder client framework gateway model http standard_framework utils rustls_backend
-          - name: simd-json
-            features: default_no_backend rustls_backend simd_json
+            features: framework rustls_backend
           - name: no gateway
-            features: model http rustls_backend
+            features: model rustls_backend
           - name: chrono
             features: chrono
           - name: unstable API + typesize
-            features: default unstable_discord_api typesize
+            features: default unstable typesize
             dont-test: true
           - name: builder without model
             features: builder
             dont-test: true
           - name: unstable Discord API (no default features)
-            features: unstable_discord_api
+            features: unstable
             dont-test: true
+          - name: zlib compression
+            features: default transport_compression_zlib
+          - name: zstd compression
+            features: default transport_compression_zstd
+          - name: zlib and zstd compression
+            features: default transport_compression_zlib transport_compression_zstd
 
     steps:
       - name: Checkout sources
@@ -131,9 +137,6 @@ jobs:
       - name: Cache
         uses: Swatinem/rust-cache@v2
 
-      - name: Remove cargo build config
-        run: rm .cargo/config.toml
-
       - name: Build
         run: cargo build
 
@@ -210,8 +213,7 @@ jobs:
 
       - name: Build docs
         run: |
-          cargo doc --no-deps --features collector,voice,unstable_discord_api
-          cargo doc --no-deps -p command_attr
+          cargo doc --no-deps --features full,unstable
         env:
           RUSTDOCFLAGS: -D rustdoc::broken_intra_doc_links
 
@@ -241,32 +243,26 @@ jobs:
       - name: 'Check example 4'
         run: cargo check -p e04_message_builder
       - name: 'Check example 5'
-        run: cargo check -p e05_command_framework
+        run: cargo check -p e05_sample_bot_structure
       - name: 'Check example 6'
-        run: cargo check -p e06_sample_bot_structure
+        run: cargo check -p e06_env_logging
       - name: 'Check example 7'
-        run: cargo check -p e07_env_logging
+        run: cargo check -p e07_shard_manager
       - name: 'Check example 8'
-        run: cargo check -p e08_shard_manager
-      - name: 'Check example 9'
-        run: cargo check -p e09_create_message_builder
+        run: cargo check -p e08_create_message_builder
+      - name: 'Check example 09'
+        run: cargo check -p e09_collectors
       - name: 'Check example 10'
-        run: cargo check -p e10_collectors
+        run: cargo check -p e10_gateway_intents
       - name: 'Check example 11'
-        run: cargo check -p e11_gateway_intents
+        run: cargo check -p e11_global_data
       - name: 'Check example 12'
-        run: cargo check -p e12_global_data
+        run: cargo check -p e12_parallel_loops
       - name: 'Check example 13'
-        run: cargo check -p e13_parallel_loops
+        run: cargo check -p e13_sqlite_database
       - name: 'Check example 14'
-        run: cargo check -p e14_slash_commands
+        run: cargo check -p e14_message_components
       - name: 'Check example 15'
-        run: cargo check -p e15_simple_dashboard
+        run: cargo check -p e15_webhook
       - name: 'Check example 16'
-        run: cargo check -p e16_sqlite_database
-      - name: 'Check example 17'
-        run: cargo check -p e17_message_components
-      - name: 'Check example 18'
-        run: cargo check -p e18_webhook
-      - name: 'Check example 19'
-        run: cargo check -p e19_interactions_endpoint
+        run: cargo check -p e16_interactions_endpoint

.github/workflows/docs.yml

@@ -31,7 +31,6 @@ jobs:
           RUSTDOCFLAGS: --cfg docsrs -D warnings
         run: |
           cargo doc --no-deps --features full
-          cargo doc --no-deps -p command_attr
 
       - name: Prepare docs
         shell: bash -e -O extglob {0}

CONTRIBUTING.md

@@ -63,10 +63,9 @@ your code.
 
 ## Unsafe
 
-Code that defines or uses `unsafe` functions must be reasoned with comments.
-`unsafe` code can pose a potential for undefined behaviour related bugs and other
-kinds of bugs to sprout if misused, weakening security. If you commit code containing
-`unsafe`, you should confirm that its usage is necessary and correct.
+Unsafe code is forbidden, and safe alternatives must be found. This can be mitigated by using
+a third party crate to offload the burden of justifying the unsafe code, or finding a safe
+alternative.
 
 # Comment / Documentation style
 

Cargo.toml

@@ -24,49 +24,55 @@ repository = "https://github.com/serenity-rs/serenity.git"
 keywords = ["discord", "api"]
 license = "ISC"
 edition = "2021"
-rust-version = "1.74"
+rust-version = "1.82"
 
 [dependencies]
 # Required dependencies
 bitflags = "2.4.2"
 serde_json = "1.0.108"
 async-trait = "0.1.74"
 tracing = { version = "0.1.40", features = ["log"] }
-serde = { version = "1.0.192", features = ["derive"] }
+serde = { version = "1.0.192", features = ["derive", "rc"] }
 url = { version = "2.4.1", features = ["serde"] }
-tokio = { version = "1.34.0", features = ["fs", "macros", "rt", "sync", "time", "io-util"] }
+tokio = { version = "1.34.0", features = ["macros", "rt", "sync", "time", "io-util"] }
 futures = { version = "0.3.29", default-features = false, features = ["std"] }
 time = { version = "0.3.36", features = ["formatting", "parsing", "serde-well-known"] }
 base64 = { version = "0.22.0" }
-secrecy = { version = "0.8.0", features = ["serde"] }
+zeroize = { version = "1.7" } # Not used in serenity, but bumps the minimal version from secrecy
 arrayvec = { version = "0.7.4", features = ["serde"] }
 serde_cow = { version = "0.1.0" }
+small-fixed-array = { version = "0.4", features = ["serde"] }
+bool_to_bitflags = { version = "0.1.2" }
+nonmax = { version = "0.5.5", features = ["serde"] }
+strum = { version = "0.26", features = ["derive"] }
+to-arraystring = "0.2.0"
+extract_map = { version = "0.1.0", features = ["serde", "iter_mut"] }
+aformat = "0.1.3"
+bytes = "1.5.0"
+foldhash = "0.1.4"
 # Optional dependencies
-fxhash = { version = "0.2.1", optional = true }
-simd-json = { version = "0.13.4", optional = true }
-uwl = { version = "0.6.0", optional = true }
-levenshtein = { version = "1.0.5", optional = true }
 chrono = { version = "0.4.31", default-features = false, features = ["clock", "serde"], optional = true }
 flate2 = { version = "1.0.28", optional = true }
-reqwest = { version = "0.11.22", default-features = false, features = ["multipart", "stream"], optional = true }
-static_assertions = { version = "1.1.0", optional = true }
-tokio-tungstenite = { version = "0.21.0", optional = true }
-typemap_rev = { version = "0.3.0", optional = true }
-bytes = { version = "1.5.0", optional = true }
+zstd-safe = { version = "7.2.1", optional = true }
+reqwest = { version = "0.12.2", default-features = false, features = ["multipart", "stream", "json"], optional = true }
+tokio-tungstenite = { version = "0.26.1", features = ["url"], optional = true }
 percent-encoding = { version = "2.3.0", optional = true }
 mini-moka = { version = "0.10.2", optional = true }
 mime_guess = { version = "2.0.4", optional = true }
-dashmap = { version = "5.5.3", features = ["serde"], optional = true }
-parking_lot = { version = "0.12.1", optional = true }
+dashmap = { version = "6.1.0", features = ["serde"], optional = true }
+parking_lot = { version = "0.12.1"}
 ed25519-dalek = { version = "2.0.0", optional = true }
-typesize = { version = "0.1.2", optional = true, features = ["url", "time", "serde_json", "secrecy", "dashmap", "parking_lot", "details"] }
+typesize = { version = "0.1.6", optional = true, features = ["url", "time", "serde_json", "secrecy", "parking_lot", "nonmax", "extract_map_01"] }
 # serde feature only allows for serialisation,
 # Serenity workspace crates
-command_attr = { version = "0.5.3", path = "./command_attr", optional = true }
 serenity-voice-model = { version = "0.2.0", path = "./voice-model", optional = true }
 
+# TODO (xacrimon): remove when https://github.com/GnomedDev/extract_map/pull/2 is merged and released
+[patch.crates-io]
+extract_map = { git = "https://github.com/xacrimon/extract_map.git", rev = "d7c2cd6" }
+
 [dev-dependencies.http_crate]
-version = "0.2.11"
+version = "1.1.0"
 package = "http"
 
 [features]
@@ -76,49 +82,44 @@ default_native_tls = ["default_no_backend", "native_tls_backend"]
 
 # Serenity requires a backend, this picks all default features without a backend.
 default_no_backend = [
-    "builder",
     "cache",
     "chrono",
-    "client",
     "framework",
-    "gateway",
-    "model",
-    "http",
-    "standard_framework",
-    "utils",
+    "transport_compression_zlib",
+    "transport_compression_zstd",
 ]
 
 # Enables builder structs to configure Discord HTTP requests. Without this feature, you have to
 # construct JSON manually at some places.
-builder = []
+builder = ["tokio/fs"]
 # Enables the cache, which stores the data received from Discord gateway to provide access to
 # complete guild data, channels, users and more without needing HTTP requests.
-cache = ["fxhash", "dashmap", "parking_lot"]
+cache = ["dashmap"]
 # Enables collectors, a utility feature that lets you await interaction events in code with
 # zero setup, without needing to setup an InteractionCreate event listener.
-collector = ["gateway", "model"]
-# Wraps the gateway and http functionality into a single interface
-# TODO: should this require "gateway"?
-client = ["http", "typemap_rev"]
+collector = ["gateway"]
 # Enables the Framework trait which is an abstraction for old-style text commands.
-framework = ["client", "model", "utils"]
+framework = ["gateway"]
 # Enables gateway support, which allows bots to listen for Discord events.
-gateway = ["flate2"]
+gateway = ["model", "flate2"]
 # Enables HTTP, which enables bots to execute actions on Discord.
-http = ["mime_guess", "percent-encoding"]
+http = ["dashmap", "mime_guess", "percent-encoding"]
 # Enables wrapper methods around HTTP requests on model types.
 # Requires "builder" to configure the requests and "http" to execute them.
 # Note: the model type definitions themselves are always active, regardless of this feature.
 # TODO: remove dependeny on utils feature
 model = ["builder", "http", "utils"]
 voice_model = ["serenity-voice-model"]
-standard_framework = ["framework", "uwl", "levenshtein", "command_attr", "static_assertions", "parking_lot"]
+# Enables zlib-stream transport compression of incoming gateway events.
+transport_compression_zlib = ["flate2", "gateway"]
+# Enables zstd-stream transport compression of incoming gateway events.
+transport_compression_zstd = ["zstd-safe", "gateway"]
 # Enables support for Discord API functionality that's not stable yet, as well as serenity APIs that
 # are allowed to change even in semver non-breaking updates.
-unstable_discord_api = []
+unstable = []
 # Enables some utility functions that can be useful for bot creators.
 utils = []
-voice = ["client", "model"]
+voice = ["gateway"]
 # Enables unstable tokio features to give explicit names to internally spawned tokio tasks
 tokio_task_builder = ["tokio/tracing"]
 interactions_endpoint = ["ed25519-dalek"]
@@ -127,33 +128,33 @@ chrono = ["dep:chrono", "typesize?/chrono"]
 
 # This enables all parts of the serenity codebase
 # (Note: all feature-gated APIs to be documented should have their features listed here!)
-full = ["default", "collector", "unstable_discord_api", "voice", "voice_model", "interactions_endpoint"]
-
-# Enables simd accelerated parsing.
-simd_json = ["simd-json", "typesize?/simd_json"]
+#
+# Unstable functionality should be gated under the `unstable` feature.
+full = ["default", "collector", "voice", "voice_model", "interactions_endpoint"]
 
 # Enables temporary caching in functions that retrieve data via the HTTP API.
 temp_cache = ["cache", "mini-moka", "typesize?/mini_moka"]
 
-# Removed feature (https://github.com/serenity-rs/serenity/pull/2246)
-absolute_ratelimits = []
+typesize = ["dep:typesize", "dashmap/typesize", "small-fixed-array/typesize", "bool_to_bitflags/typesize"]
+
+# Enables compile-time heavy instrument macros from tracing
+tracing_instrument = ["tracing/attributes"]
 
 # Backends to pick from:
 # - Rustls Backends
 rustls_backend = [
     "reqwest/rustls-tls",
     "tokio-tungstenite/rustls-tls-webpki-roots",
-    "bytes",
 ]
 
 # - Native TLS Backends
 native_tls_backend = [
     "reqwest/native-tls",
     "tokio-tungstenite/native-tls",
-    "bytes",
 ]
 
 
 [package.metadata.docs.rs]
 features = ["full"]
 rustdoc-args = ["--cfg", "docsrs"]
+