Add active user tracking #350

tadzik · 2021-09-01T15:44:58Z

No description provided.

src/bridge.ts

…mitter

Half-Shot

Looking mostly good. I think for the public classes / functions we need some more docstring for the API docs. I am quite excited that this looks generic for all bridges though!

Half-Shot · 2021-09-07T08:47:10Z

changelog.d/350.feature

@@ -0,0 +1 @@
+Add optional UserActivityTracker and BridgeBlocker


Let's elaborate what these do, so the layman can tell if they want to upgrade or not.

How about something like "Add optional UserActivityTracker for tracking & reporting monthly active users, and BridgeBlocker allowing for locking down the bridge communications (intended to be used together)"?

That seems fine to me!

Done in 8d97470

spec/unit/userActivity.spec.js

src/bridge.ts

src/components/bridge-blocker.ts

src/components/intent.ts

src/components/userActivity.ts

Half-Shot · 2021-09-07T08:59:35Z

src/components/bridge-blocker.ts

+import * as logging from "./logging";
+const log = logging.get("BridgeBlocker");
+
+export class BridgeBlocker {


Actually, what's the expected usage pattern here? Do bridges use this class directly?

They might.

IRC uses it as-is

Slack extends it to disable its connection handlers as a blocking mechanism.

Another dumb question, does this spit out a integer to Prometheus yet telling us if the bridge is blocked?

Oops. No. Will fix that :)

...actually, we can't easily do that without introducing an (optional) dependency on BridgeBlocker – currently we merely provide it for implementations but we don't force them to use it, or even assume that they might. Adding a Bridge opts/controller attribute just for the metric seems silly, so it may be better to just leave that up to the implementations.

Now done in IRC and Slack

This tests that we're properly exporting them (and is tidier). Co-authored-by: Will Hunt <will@half-shot.uk>

Half-Shot

I think this is the home stretch now, a couple of Qs but then I think we can shippit

Half-Shot · 2021-09-09T00:57:44Z

changelog.d/350.feature

@@ -0,0 +1 @@
+Add optional UserActivityTracker and BridgeBlocker


That seems fine to me!

Half-Shot · 2021-09-09T10:33:16Z

src/bridge.ts

@@ -39,6 +40,7 @@ import { RoomLinkValidator, RoomLinkValidatorStatus, Rules } from "./components/
 import { RoomUpgradeHandler, RoomUpgradeHandlerOpts } from "./components/room-upgrade-handler";
 import { EventQueue } from "./components/event-queue";
 import * as logging from "./components/logging";
+import { UserActivityTracker } from "./components/userActivity";


Still the case ?

Half-Shot · 2021-09-09T10:33:35Z

src/bridge.ts

@@ -62,6 +64,7 @@ const INTENT_CULL_EVICT_AFTER_MS = 1000 * 60 * 15; // 15 minutes

 export const BRIDGE_PING_EVENT_TYPE = "org.matrix.bridge.ping";
 export const BRIDGE_PING_TIMEOUT_MS = 60000;
+export const BRIDGE_USER_ACTIVITY_STORAGE_KEY = "org.matrix.bridge.user_activity";


src/bridge.ts

Half-Shot · 2021-09-09T10:35:58Z

src/components/bridge-blocker.ts

+import * as logging from "./logging";
+const log = logging.get("BridgeBlocker");
+
+export class BridgeBlocker {


Another dumb question, does this spit out a integer to Prometheus yet telling us if the bridge is blocked?

src/components/intent.ts

Add active user tracking

6b67564

tadzik marked this pull request as draft September 1, 2021 15:48

Half-Shot reviewed Sep 1, 2021

View reviewed changes

src/bridge.ts Outdated Show resolved Hide resolved

tadzik added 2 commits September 2, 2021 15:32

Replace the storage API of UserActivityTracker with an change event e…

d1d5031

…mitter

Add a UserActivityStore for bridges using NeDB

1f54d08

tadzik force-pushed the tadzik/active-user-tracking branch from 4b8bec1 to 1f54d08 Compare September 2, 2021 13:57

Add a getter for userActivityTracker

11d0d10

tadzik marked this pull request as ready for review September 2, 2021 13:58

tadzik mentioned this pull request Sep 2, 2021

Implement MAB's UserActivityTracker and blocking the bridge upon exceeding the user limit matrix-org/matrix-appservice-irc#1472

Merged

Enable incremental updates for user activity

fae96e6

tadzik mentioned this pull request Sep 3, 2021

Implement RMAU limits and bridge blocking matrix-org/matrix-appservice-slack#612

Merged

tadzik added 2 commits September 6, 2021 13:50

Make it BridgeController's responsibility to manage UserActivityTracker

a3c3b42

Add a BridgeBlocker component

ad36297

tadzik force-pushed the tadzik/active-user-tracking branch from 4e21904 to ad36297 Compare September 6, 2021 12:03

tadzik added 2 commits September 6, 2021 15:39

Add a changelog entry

83706d4

Add rmau tracking to prometheus metrics

a27eada

Half-Shot reviewed Sep 7, 2021

View reviewed changes

tadzik and others added 3 commits September 7, 2021 14:03

Pull test dependencies from the package root

ec70021

This tests that we're properly exporting them (and is tidier). Co-authored-by: Will Hunt <will@half-shot.uk>

Make BridgeBlocker API more async, allowing it to be testable. Add tests

2a8861a

Add docstrings to BridgeBlocker and UserActivityTracker

6be73b5

Half-Shot reviewed Sep 9, 2021

View reviewed changes

tadzik added 2 commits September 9, 2021 16:05

Clarify the changelog entry

8d97470

Make userActivity files kebab-cased; other minor cosmetic issues

faf1bc6

Half-Shot approved these changes Sep 15, 2021

View reviewed changes

tadzik merged commit 0b680bb into develop Sep 21, 2021

Half-Shot deleted the tadzik/active-user-tracking branch May 2, 2023 16:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add active user tracking #350

Add active user tracking #350

tadzik commented Sep 1, 2021

Half-Shot left a comment

Half-Shot Sep 7, 2021

tadzik Sep 7, 2021

Half-Shot Sep 9, 2021

tadzik Sep 9, 2021

Half-Shot Sep 7, 2021

tadzik Sep 7, 2021

Half-Shot Sep 9, 2021

tadzik Sep 9, 2021

tadzik Sep 9, 2021

tadzik Sep 15, 2021

Half-Shot left a comment

Half-Shot Sep 9, 2021

Half-Shot Sep 9, 2021

Half-Shot Sep 9, 2021

Half-Shot Sep 9, 2021

		@@ -0,0 +1 @@
		Add optional UserActivityTracker and BridgeBlocker

Add active user tracking #350

Add active user tracking #350

Conversation

tadzik commented Sep 1, 2021

Half-Shot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Half-Shot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment