-
-
-
+
+
+
Select the context fields you want to include in the
diff --git a/frontend/src/hooks/api/actions/useSignOnLogApi/useSignOnLogApi.ts b/frontend/src/hooks/api/actions/useLoginHistoryApi/useLoginHistoryApi.ts
similarity index 89%
rename from frontend/src/hooks/api/actions/useSignOnLogApi/useSignOnLogApi.ts
rename to frontend/src/hooks/api/actions/useLoginHistoryApi/useLoginHistoryApi.ts
index bd2078017d..38ab16bdd5 100644
--- a/frontend/src/hooks/api/actions/useSignOnLogApi/useSignOnLogApi.ts
+++ b/frontend/src/hooks/api/actions/useLoginHistoryApi/useLoginHistoryApi.ts
@@ -1,6 +1,6 @@
import useAPI from '../useApi/useApi';
-export const useSignOnLogApi = () => {
+export const useLoginHistoryApi = () => {
const { loading, makeRequest, createRequest, errors } = useAPI({
propagateErrors: true,
});
@@ -8,7 +8,7 @@ export const useSignOnLogApi = () => {
const downloadCSV = async () => {
const requestId = 'downloadCSV';
const req = createRequest(
- 'api/admin/signons',
+ 'api/admin/logins',
{
method: 'GET',
responseType: 'blob',
@@ -25,7 +25,7 @@ export const useSignOnLogApi = () => {
const removeEvent = async (eventId: number) => {
const requestId = 'removeEvent';
const req = createRequest(
- `api/admin/signons/${eventId}`,
+ `api/admin/logins/${eventId}`,
{ method: 'DELETE' },
requestId
);
@@ -36,7 +36,7 @@ export const useSignOnLogApi = () => {
const removeAllEvents = async () => {
const requestId = 'removeAllEvents';
const req = createRequest(
- 'api/admin/signons',
+ 'api/admin/logins',
{ method: 'DELETE' },
requestId
);
diff --git a/frontend/src/hooks/api/getters/useSignOnLog/useSignOnLog.ts b/frontend/src/hooks/api/getters/useLoginHistory/useLoginHistory.ts
similarity index 68%
rename from frontend/src/hooks/api/getters/useSignOnLog/useSignOnLog.ts
rename to frontend/src/hooks/api/getters/useLoginHistory/useLoginHistory.ts
index 812f078bdd..ab66c8060e 100644
--- a/frontend/src/hooks/api/getters/useSignOnLog/useSignOnLog.ts
+++ b/frontend/src/hooks/api/getters/useLoginHistory/useLoginHistory.ts
@@ -1,25 +1,25 @@
-import { ISignOnEvent } from 'interfaces/signOnEvent';
+import { ILoginEvent } from 'interfaces/loginEvent';
import { useMemo } from 'react';
import { formatApiPath } from 'utils/formatPath';
import handleErrorResponses from '../httpErrorResponseHandler';
import { useConditionalSWR } from '../useConditionalSWR/useConditionalSWR';
import useUiConfig from '../useUiConfig/useUiConfig';
-export const useSignOnLog = () => {
+export const useLoginHistory = () => {
const { uiConfig, isEnterprise } = useUiConfig();
- const { signOnLog } = uiConfig.flags;
+ const { loginHistory } = uiConfig.flags;
const { data, error, mutate } = useConditionalSWR(
- signOnLog && isEnterprise(),
+ loginHistory && isEnterprise(),
{ events: [] },
- formatApiPath(`api/admin/signons`),
+ formatApiPath(`api/admin/logins`),
fetcher
);
return useMemo(
() => ({
- events: (data?.events ?? []) as ISignOnEvent[],
+ events: (data?.events ?? []) as ILoginEvent[],
loading: !error && !data,
refetch: () => mutate(),
error,
@@ -30,6 +30,6 @@ export const useSignOnLog = () => {
const fetcher = (path: string) => {
return fetch(path)
- .then(handleErrorResponses('Sign-On Log'))
+ .then(handleErrorResponses('Login History'))
.then(res => res.json());
};
diff --git a/frontend/src/interfaces/signOnEvent.ts b/frontend/src/interfaces/loginEvent.ts
similarity index 82%
rename from frontend/src/interfaces/signOnEvent.ts
rename to frontend/src/interfaces/loginEvent.ts
index 285709ac5c..c543829b30 100644
--- a/frontend/src/interfaces/signOnEvent.ts
+++ b/frontend/src/interfaces/loginEvent.ts
@@ -1,4 +1,4 @@
-export interface ISignOnEvent {
+export interface ILoginEvent {
id: number;
username: string;
auth_type: string;
diff --git a/frontend/src/interfaces/uiConfig.ts b/frontend/src/interfaces/uiConfig.ts
index e9f32e352c..945d3addd5 100644
--- a/frontend/src/interfaces/uiConfig.ts
+++ b/frontend/src/interfaces/uiConfig.ts
@@ -47,7 +47,7 @@ export interface IFlags {
showProjectApiAccess?: boolean;
proPlanAutoCharge?: boolean;
notifications?: boolean;
- signOnLog?: boolean;
+ loginHistory?: boolean;
}
export interface IVersionInfo {
diff --git a/package.json b/package.json
index d27b9a8fdc..5bcbfe98cd 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
{
"name": "unleash-server",
"description": "Unleash is an enterprise ready feature toggles service. It provides different strategies for handling feature toggles.",
- "version": "4.22.0-beta.33",
+ "version": "4.22.0-beta.35",
"keywords": [
"unleash",
"feature toggle",
diff --git a/src/lib/__snapshots__/create-config.test.ts.snap b/src/lib/__snapshots__/create-config.test.ts.snap
index ccd38d593a..2c650e6b8a 100644
--- a/src/lib/__snapshots__/create-config.test.ts.snap
+++ b/src/lib/__snapshots__/create-config.test.ts.snap
@@ -74,6 +74,7 @@ exports[`should create default config 1`] = `
"embedProxy": true,
"embedProxyFrontend": true,
"featuresExportImport": false,
+ "loginHistory": false,
"maintenanceMode": false,
"messageBanner": false,
"newProjectOverview": false,
@@ -83,7 +84,6 @@ exports[`should create default config 1`] = `
"proxyReturnAllToggles": false,
"responseTimeWithAppNameKillSwitch": false,
"showProjectApiAccess": false,
- "signOnLog": false,
"strictSchemaValidation": false,
},
},
@@ -96,6 +96,7 @@ exports[`should create default config 1`] = `
"embedProxy": true,
"embedProxyFrontend": true,
"featuresExportImport": false,
+ "loginHistory": false,
"maintenanceMode": false,
"messageBanner": false,
"newProjectOverview": false,
@@ -105,7 +106,6 @@ exports[`should create default config 1`] = `
"proxyReturnAllToggles": false,
"responseTimeWithAppNameKillSwitch": false,
"showProjectApiAccess": false,
- "signOnLog": false,
"strictSchemaValidation": false,
},
"externalResolver": {
diff --git a/src/lib/types/experimental.ts b/src/lib/types/experimental.ts
index 87addfaa88..2bafbb3fc1 100644
--- a/src/lib/types/experimental.ts
+++ b/src/lib/types/experimental.ts
@@ -63,7 +63,7 @@ const flags = {
false,
),
notifications: parseEnvVarBoolean(process.env.NOTIFICATIONS, false),
- signOnLog: parseEnvVarBoolean(process.env.UNLEASH_SIGN_ON_LOG, false),
+ loginHistory: parseEnvVarBoolean(process.env.UNLEASH_LOGIN_HISTORY, false),
};
export const defaultExperimentalOptions: IExperimentalOptions = {
diff --git a/src/migrations/20230302133740-rename-sign-on-log-table-to-login-history.js b/src/migrations/20230302133740-rename-sign-on-log-table-to-login-history.js
new file mode 100644
index 0000000000..dc061955d9
--- /dev/null
+++ b/src/migrations/20230302133740-rename-sign-on-log-table-to-login-history.js
@@ -0,0 +1,20 @@
+exports.up = function (db, cb) {
+ db.runSql(`ALTER TABLE sign_on_log RENAME TO login_history`, cb);
+ db.runSql(`DELETE FROM settings WHERE name = 'sign_on_log_retention'`, cb);
+ db.runSql(
+ `INSERT INTO settings(name, content) VALUES ('login_history_retention', '{"hours": 336}')`,
+ cb,
+ );
+};
+
+exports.down = function (db, cb) {
+ db.runSql(`ALTER TABLE login_history RENAME TO sign_on_log`, cb);
+ db.runSql(
+ `DELETE FROM settings WHERE name = 'login_history_retention'`,
+ cb,
+ );
+ db.runSql(
+ `INSERT INTO settings(name, content) VALUES ('sign_on_log_retention', '{"hours": 336}')`,
+ cb,
+ );
+};
diff --git a/website/docs/reference/deploy/configuring-unleash.md b/website/docs/reference/deploy/configuring-unleash.md
index 2c61d0629a..cb904cafc7 100644
--- a/website/docs/reference/deploy/configuring-unleash.md
+++ b/website/docs/reference/deploy/configuring-unleash.md
@@ -180,6 +180,20 @@ const start = async () => {
start();
```
+### Segment limits {#segments}
+
+:::caution
+
+Changing segment limits could have a negative impact on the performance of Unleash SDKs and cause network congestion. Think twice before changing these values.
+
+:::
+
+Some facets of the [segments feature](../segments.mdx) can be customized via environment variables. This lets you change the [segment limits](../segments.mdx#segment-limits) that Unleash uses.
+
+`UNLEASH_STRATEGY_SEGMENTS_LIMIT` controls the maximum number of segments that can be applied to a single strategy. The default is 5.
+
+`UNLEASH_SEGMENT_VALUES_LIMIT` controls the maximum number of values that you can assign across a segment's constraints. The default is 100.
+
## Securing Unleash {#securing-unleash}
You can integrate Unleash with your authentication provider (OAuth 2.0). Read more about [securing unleash](./securing-unleash.md).
diff --git a/website/docs/reference/segments.mdx b/website/docs/reference/segments.mdx
index 5ded1c3724..917adc535d 100644
--- a/website/docs/reference/segments.mdx
+++ b/website/docs/reference/segments.mdx
@@ -38,6 +38,22 @@ Segments are collections of strategy constraints. To satisfy a segment, _all_ th
If an activation strategy has a segment _and_ additional constraints applied, the segment _and_ the strategies must all be satisfied. Similarly, if an activation strategy has multiple segments, then they must _must all be satisfied_.
+## Segment limits
+
+In theory, you could create segments with a thousand constraints, each with a million values. But this wouldn't scale well, so there are limitations in place to stop you from doing this. Unleash enforces the following limits on use of segments:
+
+1. By default, a segment can have **at most 100 values** specified across all of its constraints. That means that if you add a constraint that uses 10 values, you will have 90 more values to use for any other constraints you add to the same segment.
+
+2. By default, you can apply **at most 5 segments to any one strategy**. Separate strategies (even on the same feature) do not count towards the same total, so you can have two strategies with 5 segments each.
+
+You **can** [configure segment limits](deploy/configuring-unleash.md#segments) with environment variables.
+
+### A note on large segments {#large-segments}
+
+Segments are just constraints, so any limitations that apply to constraints also apply to segments.
+
+This means that if you want to add a hundred different user IDs to one of your constraints, you are most likely better off thinking about finding another way to solve this problem. That may be using a different abstraction or finding another pattern that you can use instead. Refer to the section on [constraint limitations](../reference/strategy-constraints.md#limitations) for a more thorough explanation.
+
## Creating, updating, and deleting segments
Segments can be created, edited, and deleted from the segments page in the admin UI or via the API (see the [segments API documentation](/reference/api/legacy/unleash/admin/segments.mdx)).
@@ -45,9 +61,3 @@ Segments can be created, edited, and deleted from the segments page in the admin
A segment that is in use **cannot** be deleted. If you'd like to delete a segment that is in use, you must first remove the segment from all the activation strategies that are currently using it.
-
-### A note on large segments and limits {#large-segments}
-
-In theory, you could you create segments with a thousand constraints, each with a million values. But this wouldn't scale well, so there are limitations in place to stop you from doing this. Segments are just constraints, so any limitations that apply to constraints also apply to segments.
-
-This means that if you want to add a hundred different user IDs to one of your constraints, you are most likely better off thinking about finding another way to solve this problem. That may be using a different abstraction or finding another pattern that you can use instead. Refer to the section on [constraint limitations](../reference/strategy-constraints.md#limitations) for a more thorough explanation.