Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

Commit

Permalink
Deprecate lab experiment 'feature_state_counters' (#11343)
Browse files Browse the repository at this point in the history 
* Deprecate lab experiment 'feature_state_counters'

* i18n

* Regenerate strings

---------

Co-authored-by: Johannes Marbach <[email protected]>
  • Loading branch information
@germain-gg @Johennes
germain-gg and Johennes authored Nov 30, 2023
1 parent 890958e commit 07b7ee6
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 178 deletions.
37 changes: 0 additions & 37 deletions res/css/views/rooms/_AuxPanel.pcss
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,41 +20,4 @@ limitations under the License.
margin: 0px auto;

overflow: auto;

.mx_AuxPanel_stateViews {
padding: 5px;
padding-left: 19px;
border-bottom: 1px solid $primary-hairline-color;
}

.mx_AuxPanel_stateViews_span {
&[data-severity="warning"] {
font-weight: bold;
color: orange;
}

&[data-severity="alert"] {
font-weight: bold;
color: red;
}

&[data-severity="normal"] {
font-weight: normal;
}

&[data-severity="notice"] {
font-weight: normal;
color: $settings-grey-fg-color;
}

a {
text-decoration: none;
color: inherit;
}
}

.mx_AuxPanel_stateViews_delim {
padding: 0 5px;
color: $settings-grey-fg-color;
}
}
138 changes: 5 additions & 133 deletions src/components/views/rooms/AuxPanel.tsx
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright 2015, 2016, 2017, 2020 The Matrix.org Foundation C.I.C.
Copyright 2015 - 2023 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.
Expand All @@ -15,11 +15,8 @@ limitations under the License.
*/

import React, { ReactNode } from "react";
import { lexicographicCompare } from "matrix-js-sdk/src/utils";
import { Room, RoomStateEvent, MatrixEvent } from "matrix-js-sdk/src/matrix";
import { throttle } from "lodash";
import { Room } from "matrix-js-sdk/src/matrix";

import { MatrixClientPeg } from "../../../MatrixClientPeg";
import AppsDrawer from "./AppsDrawer";
import SettingsStore from "../../../settings/SettingsStore";
import AutoHideScrollbar from "../../structures/AutoHideScrollbar";
Expand All @@ -37,91 +34,13 @@ interface IProps {
children?: ReactNode;
}

interface Counter {
title: string;
value: number;
link: string;
severity: string;
stateKey: string;
}

interface IState {
counters: Counter[];
}

export default class AuxPanel extends React.Component<IProps, IState> {
export default class AuxPanel extends React.Component<IProps> {
public static defaultProps = {
showApps: true,
};

public constructor(props: IProps) {
super(props);

this.state = {
counters: this.computeCounters(),
};
}

public componentDidMount(): void {
const cli = MatrixClientPeg.safeGet();
if (SettingsStore.getValue("feature_state_counters")) {
cli.on(RoomStateEvent.Events, this.onRoomStateEvents);
}
}

public componentWillUnmount(): void {
if (SettingsStore.getValue("feature_state_counters")) {
MatrixClientPeg.get()?.removeListener(RoomStateEvent.Events, this.onRoomStateEvents);
}
}

public shouldComponentUpdate(nextProps: IProps, nextState: IState): boolean {
return objectHasDiff(this.props, nextProps) || objectHasDiff(this.state, nextState);
}

private onRoomStateEvents = (ev: MatrixEvent): void => {
if (ev.getType() === "re.jki.counter") {
this.updateCounters();
}
};

private updateCounters = throttle(
() => {
this.setState({ counters: this.computeCounters() });
},
500,
{ leading: true, trailing: true },
);

private computeCounters(): Counter[] {
const counters: Counter[] = [];

if (this.props.room && SettingsStore.getValue("feature_state_counters")) {
const stateEvs = this.props.room.currentState.getStateEvents("re.jki.counter");
stateEvs.sort((a, b) => lexicographicCompare(a.getStateKey()!, b.getStateKey()!));

for (const ev of stateEvs) {
const title = ev.getContent().title;
const value = ev.getContent().value;
const link = ev.getContent().link;
const severity = ev.getContent().severity || "normal";
const stateKey = ev.getStateKey()!;

// We want a non-empty title but can accept falsy values (e.g.
// zero)
if (title && value !== undefined) {
counters.push({
title,
value,
link,
severity,
stateKey,
});
}
}
}

return counters;
public shouldComponentUpdate(nextProps: IProps): boolean {
return objectHasDiff(this.props, nextProps);
}

public render(): React.ReactNode {
Expand All @@ -145,55 +64,8 @@ export default class AuxPanel extends React.Component<IProps, IState> {
);
}

let stateViews: JSX.Element | null = null;
if (this.state.counters && SettingsStore.getValue("feature_state_counters")) {
const counters: JSX.Element[] = [];

this.state.counters.forEach((counter, idx) => {
const title = counter.title;
const value = counter.value;
const link = counter.link;
const severity = counter.severity;
const stateKey = counter.stateKey;

let span = (
<span>
{title}: {value}
</span>
);

if (link) {
span = (
<a href={link} target="_blank" rel="noreferrer noopener">
{span}
</a>
);
}

span = (
<span className="mx_AuxPanel_stateViews_span" data-severity={severity} key={"x-" + stateKey}>
{span}
</span>
);

counters.push(span);
counters.push(
<span className="mx_AuxPanel_stateViews_delim" key={"delim" + idx}>
{" "}
─{" "}
</span>,
);
});

if (counters.length > 0) {
counters.pop(); // remove last deliminator
stateViews = <div className="mx_AuxPanel_stateViews">{counters}</div>;
}
}

return (
<AutoHideScrollbar className="mx_AuxPanel">
{stateViews}
{this.props.children}
{appsDrawer}
{callView}
Expand Down
1 change: 0 additions & 1 deletion src/i18n/strings/en_EN.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1450,7 +1450,6 @@
"sliding_sync_server_no_support": "Your server lacks native support",
"sliding_sync_server_specify_proxy": "Your server lacks native support, you must specify a proxy",
"sliding_sync_server_support": "Your server has native support",
"state_counters": "Render simple counters in room header",
"under_active_development": "Under active development.",
"unrealiable_e2e": "Unreliable in encrypted rooms",
"video_rooms": "Video rooms",
Expand Down
7 changes: 0 additions & 7 deletions src/settings/Settings.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -285,13 +285,6 @@ export const SETTINGS: { [setting: string]: ISetting } = {
supportedLevels: LEVELS_FEATURE,
default: false,
},
"feature_state_counters": {
isFeature: true,
labsGroup: LabGroup.Rooms,
displayName: _td("labs|state_counters"),
supportedLevels: LEVELS_FEATURE,
default: false,
},
"feature_mjolnir": {
isFeature: true,
labsGroup: LabGroup.Moderation,
Expand Down

0 comments on commit 07b7ee6

Please sign in to comment.