First cut of the red list module

README.md

@@ -1,7 +1,11 @@
 # "Red list" module for Tchap
 
-Hide users from user search on demand.
+This module allows users to hide themselves from user search.
 
+Users are expected to be in a single room, hidden from clients, to help user discovery
+across a closed federation. When users update their global `im.vector.hide_profile`
+account data with `{"hide_profile": True}`, they are removed from this discovery room,
+and added to a local database table to filter them out from local results.
 
 ## Installation
 
@@ -17,7 +21,9 @@ Then alter your homeserver configuration, adding to your `modules` configuration
 modules:
  - module: tchap_red_list.RedListManager
  config:
- # TODO: Complete this section with an example for your module
+ # ID of the room used for user discovery.
+ # Optional, defaults to no room.
+ discovery_room: "!someroom:example.com"
 ```
 
 
@@ -73,14 +79,4 @@ Synapse developers (assuming a Unix-like shell):
  6. Push the tag.
  ```shell
  git push origin tag v$version
- ```
-
- 7. If applicable:
- Create a *release*, based on the tag you just pushed, on GitHub or GitLab.
-
- 8. If applicable:
- Create a source distribution and upload it to PyPI:
- ```shell
- python -m build
- twine upload dist/tchap_red_list-$version*
- ```
+ ```

mypy.ini

@@ -1,2 +1,3 @@
 [mypy]
 strict = true
+plugins = scripts-dev/mypy_plugin.py

scripts-dev/mypy_plugin.py

@@ -0,0 +1,105 @@
+# Copyright 2022 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""This is a mypy plugin for Synpase to deal with some of the funky typing that
+can crop up, e.g the cache descriptors.
+This is copied directly from Synapse's codebase.
+"""
+
+from typing import Callable, Optional
+
+from mypy.nodes import ARG_NAMED_OPT
+from mypy.plugin import MethodSigContext, Plugin
+from mypy.typeops import bind_self
+from mypy.types import CallableType, NoneType
+
+
+class SynapsePlugin(Plugin):
+ def get_method_signature_hook(
+ self, fullname: str
+ ) -> Optional[Callable[[MethodSigContext], CallableType]]:
+ if fullname.startswith(
+ "synapse.util.caches.descriptors._CachedFunction.__call__"
+ ) or fullname.startswith(
+ "synapse.util.caches.descriptors._LruCachedFunction.__call__"
+ ):
+ return cached_function_method_signature
+ return None
+
+
+def cached_function_method_signature(ctx: MethodSigContext) -> CallableType:
+ """Fixes the `_CachedFunction.__call__` signature to be correct.
+
+ It already has *almost* the correct signature, except:
+
+ 1. the `self` argument needs to be marked as "bound";
+ 2. any `cache_context` argument should be removed;
+ 3. an optional keyword argument `on_invalidated` should be added.
+ """
+
+ # First we mark this as a bound function signature.
+ signature = bind_self(ctx.default_signature)
+
+ # Secondly, we remove any "cache_context" args.
+ #
+ # Note: We should be only doing this if `cache_context=True` is set, but if
+ # it isn't then the code will raise an exception when its called anyway, so
+ # its not the end of the world.
+ context_arg_index = None
+ for idx, name in enumerate(signature.arg_names):
+ if name == "cache_context":
+ context_arg_index = idx
+ break
+
+ arg_types = list(signature.arg_types)
+ arg_names = list(signature.arg_names)
+ arg_kinds = list(signature.arg_kinds)
+
+ if context_arg_index:
+ arg_types.pop(context_arg_index)
+ arg_names.pop(context_arg_index)
+ arg_kinds.pop(context_arg_index)
+
+ # Third, we add an optional "on_invalidate" argument.
+ #
+ # This is a callable which accepts no input and returns nothing.
+ calltyp = CallableType(
+ arg_types=[],
+ arg_kinds=[],
+ arg_names=[],
+ ret_type=NoneType(),
+ fallback=ctx.api.named_generic_type("builtins.function", []),
+ )
+
+ arg_types.append(calltyp)
+ arg_names.append("on_invalidate")
+ arg_kinds.append(ARG_NAMED_OPT) # Arg is an optional kwarg.
+
+ signature = signature.copy_modified(
+ arg_types=arg_types,
+ arg_names=arg_names,
+ arg_kinds=arg_kinds,
+ )
+
+ return signature
+
+
+def plugin(version: str):
+ # This is the entry point of the plugin, and let's us deal with the fact
+ # that the mypy plugin interface is *not* stable by looking at the version
+ # string.
+ #
+ # However, since we pin the version of mypy Synapse uses in CI, we don't
+ # really care.
+ return SynapsePlugin

setup.cfg

@@ -29,9 +29,9 @@ dev =
  twisted
  aiounittest
  # for type checking
- mypy == 0.910
+ mypy == 0.931
  # for linting
- black == 21.9b0
+ black == 22.3.0
  flake8 == 4.0.1
  isort == 5.9.3