Mirrors
/
nextcloud-spreed
mirror of https://github.com/nextcloud/spreed
3
0
Fork 0
Code Releases Activity
Browse Source

feat(experiments): Allow testing some experimental features per instance 

Signed-off-by: Joas Schilling <coding@schilljs.com>
pull/15174/head
Joas Schilling 5 months ago
committed by backportbot[bot]
parent
3bb0d02dc1
commit
1bcc016e3f
23 changed files with 192 additions and 8 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 1
      docs/capabilities.md
  2. 10
      docs/settings.md
  3. 6
      lib/Capabilities.php
  4. 6
      lib/Controller/RoomController.php
  5. 3
      lib/ResponseDefinitions.php
  6. 16
      openapi-administration.json
  7. 16
      openapi-backend-recording.json
  8. 16
      openapi-backend-signaling.json
  9. 16
      openapi-backend-sipbridge.json
  10. 16
      openapi-bots.json
  11. 16
      openapi-federation.json
  12. 16
      openapi-full.json
  13. 16
      openapi.json
  14. 6
      src/__mocks__/capabilities.ts
  15. 4
      src/types/openapi/openapi-administration.ts
  16. 4
      src/types/openapi/openapi-backend-recording.ts
  17. 4
      src/types/openapi/openapi-backend-signaling.ts
  18. 4
      src/types/openapi/openapi-backend-sipbridge.ts
  19. 4
      src/types/openapi/openapi-bots.ts
  20. 4
      src/types/openapi/openapi-federation.ts
  21. 4
      src/types/openapi/openapi-full.ts
  22. 4
      src/types/openapi/openapi.ts
  23. 8
      tests/php/CapabilitiesTest.php

1
docs/capabilities.md
View File

@ -188,6 +188,7 @@
* `config => conversations => retention-instant-meetings` (local) - Number of days before an instant meeting conversation is deleted (`0` = disabled)
* `config => conversations => retention-phone` (local) - Number of days before an inactive incoming or outgoing phone conversation is deleted (`0` = disabled)
* `config => call => predefined-backgrounds-v2` (local) - Whether virtual backgrounds should be read from the theming directory
* `config => experiments => enabled` (local) - Bit flag of enabled experiments for clients
* `dashboard-event-rooms` (local) - Whether Talk APIs offer functionality for Dashboard requests
* `mutual-calendar-events` (local) - Whether Talk APIs offer mutual calendar events for 1:1 rooms
* `upcoming-reminders` (local) - Whether the API to list upcoming reminders exists

10
docs/settings.md
View File

@ -102,6 +102,8 @@ Legend:
| `retention_event_rooms` | int | `28` | No | | Retention period of event conversations in days (`0` means no-retention) |
| `retention_phone_rooms` | int | `7` | No | | Retention period of phone dial-in and dial-out conversations in days (`0` means no-retention) |
| `retention_instant_meetings` | int | `1` | No | | Retention period of instant meetings in days (`0` means no-retention) |
| `experiments_users` | int | `0` | Yes | | Bit flag of experiments that should be enabled for logged-in users on this server (see [Experiments](#experiments) below) |
| `experiments_guests` | int | `0` | Yes | | Bit flag of experiments that should be enabled for guests on this server (see [Experiments](#experiments) below) |
| `grid_videos_limit_enforced` | string<br>`yes` or `no` | `no` | No | | Whether the number of grid videos should be enforced |
| `changelog` | string<br>`yes` or `no` | `yes` | No | | Whether the changelog conversation is updated with new features on major releases |
| `has_reference_id` | string<br>`yes` or `no` | `no` | Yes | | Indicator whether the clients can use the reference value to identify their message, will be automatically set to `yes` when the repair steps are executed |
@ -128,3 +130,11 @@ Legend:
| `backgrounds_branded_for_guests` | string<br>`1` or `0` | `0` | No | | Whether guests are allowed to use the virtual backgrounds provided via `themes/talk-backgrounds/` |
| `backgrounds_default_for_users` | string<br>`1` or `0` | `1` | No | | Whether users are allowed to use the default virtual backgrounds provided by the releases |
| `backgrounds_upload_users` | string<br>`1` or `0` | `1` | No | | Whether users are allowed to upload custom virtual backgrounds and choose from their Nextcloud Files |
## Experiments
Features that can be toggled on-off with the `experiments_users` and `experiments_guests` bit flags:
| Bit | Status | Introduced | Ended | Description |
|-----|--------|----------------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------|
| 1 | Active | Web 21.1.0<br>Desktop 1.2.2-beta | - | Instead of refreshing the participant list repeatingly during calls, the data is generated from received signaling messages |

6
lib/Capabilities.php
View File

@ -193,6 +193,9 @@ class Capabilities implements IPublicCapability {
'session-ping-limit',
'hello-v2-token-key',
],
'experiments' => [
'enabled',
],
];
protected ICache $talkCache;
@ -277,6 +280,9 @@ class Capabilities implements IPublicCapability {
'session-ping-limit' => max(0, (int)$this->serverConfig->getAppValue('spreed', 'session-ping-limit', '200')),
// 'hello-v2-token-key' => string,
],
'experiments' => [
'enabled' => max(0, $this->appConfig->getAppValueInt($user instanceof IUser ? 'experiments_users' : 'experiments_guests')),
],
],
'config-local' => self::LOCAL_CONFIGS,
'version' => $this->appManager->getAppVersion('spreed'),

6
lib/Controller/RoomController.php
View File

@ -190,6 +190,12 @@ class RoomController extends AEnvironmentAwareOCSController {
$this->config->getAppValue('spreed', 'federation_allowed_groups', '[]'),
];
if ($this->userId !== null) {
$values[] = $this->appConfig->getAppValueInt('experiments_users');
} else {
$values[] = $this->appConfig->getAppValueInt('experiments_guests');
}
return [
'X-Nextcloud-Talk-Hash' => sha1(implode('#', $values)),
];

3
lib/ResponseDefinitions.php
View File

@ -497,6 +497,9 @@ namespace OCA\Talk;
* session-ping-limit: int,
* hello-v2-token-key?: string,
* },
* experiments: array{
* enabled: non-negative-int,
* },
* },
* config-local: array<string, non-empty-list<string>>,
* version: string,

16
openapi-administration.json
View File

@ -120,7 +120,8 @@
"conversations",
"federation",
"previews",
"signaling"
"signaling",
"experiments"
],
"properties": {
"attachments": {
@ -349,6 +350,19 @@
"type": "string"
}
}
},
"experiments": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}
}
},

16
openapi-backend-recording.json
View File

@ -53,7 +53,8 @@
"conversations",
"federation",
"previews",
"signaling"
"signaling",
"experiments"
],
"properties": {
"attachments": {
@ -282,6 +283,19 @@
"type": "string"
}
}
},
"experiments": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}
}
},

16
openapi-backend-signaling.json
View File

@ -53,7 +53,8 @@
"conversations",
"federation",
"previews",
"signaling"
"signaling",
"experiments"
],
"properties": {
"attachments": {
@ -282,6 +283,19 @@
"type": "string"
}
}
},
"experiments": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}
}
},

16
openapi-backend-sipbridge.json
View File

@ -96,7 +96,8 @@
"conversations",
"federation",
"previews",
"signaling"
"signaling",
"experiments"
],
"properties": {
"attachments": {
@ -325,6 +326,19 @@
"type": "string"
}
}
},
"experiments": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}
}
},

16
openapi-bots.json
View File

@ -53,7 +53,8 @@
"conversations",
"federation",
"previews",
"signaling"
"signaling",
"experiments"
],
"properties": {
"attachments": {
@ -282,6 +283,19 @@
"type": "string"
}
}
},
"experiments": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}
}
},

16
openapi-federation.json
View File

@ -96,7 +96,8 @@
"conversations",
"federation",
"previews",
"signaling"
"signaling",
"experiments"
],
"properties": {
"attachments": {
@ -325,6 +326,19 @@
"type": "string"
}
}
},
"experiments": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}
}
},

16
openapi-full.json
View File

@ -254,7 +254,8 @@
"conversations",
"federation",
"previews",
"signaling"
"signaling",
"experiments"
],
"properties": {
"attachments": {
@ -483,6 +484,19 @@
"type": "string"
}
}
},
"experiments": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}
}
},

16
openapi.json
View File

@ -213,7 +213,8 @@
"conversations",
"federation",
"previews",
"signaling"
"signaling",
"experiments"
],
"properties": {
"attachments": {
@ -442,6 +443,19 @@
"type": "string"
}
}
},
"experiments": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}
}
},

6
src/__mocks__/capabilities.ts
View File

@ -178,6 +178,9 @@ export const mockedCapabilities: Capabilities = {
'session-ping-limit': 200,
'hello-v2-token-key': '123',
},
experiments: {
enabled: 0,
},
},
'config-local': {
attachments: [
@ -215,6 +218,9 @@ export const mockedCapabilities: Capabilities = {
'session-ping-limit',
'hello-v2-token-key',
],
experiments: [
'enabled',
],
},
version: '20.0.0-dev.0',
}

4
src/types/openapi/openapi-administration.ts
View File

@ -278,6 +278,10 @@ export type components = {
"session-ping-limit": number;
"hello-v2-token-key"?: string;
};
experiments: {
/** Format: int64 */
enabled: number;
};
};
"config-local": {
[key: string]: string[];

4
src/types/openapi/openapi-backend-recording.ts
View File

@ -112,6 +112,10 @@ export type components = {
"session-ping-limit": number;
"hello-v2-token-key"?: string;
};
experiments: {
/** Format: int64 */
enabled: number;
};
};
"config-local": {
[key: string]: string[];

4
src/types/openapi/openapi-backend-signaling.ts
View File

@ -98,6 +98,10 @@ export type components = {
"session-ping-limit": number;
"hello-v2-token-key"?: string;
};
experiments: {
/** Format: int64 */
enabled: number;
};
};
"config-local": {
[key: string]: string[];

4
src/types/openapi/openapi-backend-sipbridge.ts
View File

@ -213,6 +213,10 @@ export type components = {
"session-ping-limit": number;
"hello-v2-token-key"?: string;
};
experiments: {
/** Format: int64 */
enabled: number;
};
};
"config-local": {
[key: string]: string[];

4
src/types/openapi/openapi-bots.ts
View File

@ -116,6 +116,10 @@ export type components = {
"session-ping-limit": number;
"hello-v2-token-key"?: string;
};
experiments: {
/** Format: int64 */
enabled: number;
};
};
"config-local": {
[key: string]: string[];

4
src/types/openapi/openapi-federation.ts
View File

@ -224,6 +224,10 @@ export type components = {
"session-ping-limit": number;
"hello-v2-token-key"?: string;
};
experiments: {
/** Format: int64 */
enabled: number;
};
};
"config-local": {
[key: string]: string[];

4
src/types/openapi/openapi-full.ts
View File

@ -2234,6 +2234,10 @@ export type components = {
"session-ping-limit": number;
"hello-v2-token-key"?: string;
};
experiments: {
/** Format: int64 */
enabled: number;
};
};
"config-local": {
[key: string]: string[];

4
src/types/openapi/openapi.ts
View File

@ -1712,6 +1712,10 @@ export type components = {
"session-ping-limit": number;
"hello-v2-token-key"?: string;
};
experiments: {
/** Format: int64 */
enabled: number;
};
};
"config-local": {
[key: string]: string[];

8
tests/php/CapabilitiesTest.php
View File

@ -115,6 +115,7 @@ class CapabilitiesTest extends TestCase {
['retention_event_rooms', 28, 28],
['retention_phone_rooms', 7, 7],
['retention_instant_meetings', 1, 1],
['experiments_guests', 0, 0],
]);
$this->assertInstanceOf(IPublicCapability::class, $capabilities);
@ -195,6 +196,9 @@ class CapabilitiesTest extends TestCase {
'signaling' => [
'session-ping-limit' => 200,
],
'experiments' => [
'enabled' => 0,
],
],
'config-local' => Capabilities::LOCAL_CONFIGS,
'version' => '1.2.3',
@ -280,6 +284,7 @@ class CapabilitiesTest extends TestCase {
['retention_event_rooms', 28, 28],
['retention_phone_rooms', 7, 7],
['retention_instant_meetings', 1, 1],
['experiments_users', 0, 0],
]);
$this->assertInstanceOf(IPublicCapability::class, $capabilities);
@ -363,6 +368,9 @@ class CapabilitiesTest extends TestCase {
'signaling' => [
'session-ping-limit' => 50,
],
'experiments' => [
'enabled' => 0,
],
],
'config-local' => Capabilities::LOCAL_CONFIGS,
'version' => '1.2.3',

Write Preview
Loading…
Cancel
Save