1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-02-19 00:15:43 +01:00

feat: remove experimental flag for telemetry (#4123)

<!-- Thanks for creating a PR! To make it easier for reviewers and
everyone else to understand what your changes relate to, please add some
relevant content to the headings below. Feel free to ignore or delete
sections that you don't think are relevant. Thank you! ❤️ -->

## About the changes
<!-- Describe the changes introduced. What are they and why are they
being introduced? Feel free to also add screenshots or steps to view the
changes if they're visual. -->

This removes the experimental feature flag that defaulted to turn off
telemetry collection
This commit is contained in:
David Leek 2023-06-30 11:27:54 +02:00 committed by GitHub
parent 4a4f14f69b
commit 78ba72d861
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 14 additions and 114 deletions

View File

@ -4,7 +4,6 @@ import { Box, styled } from '@mui/material';
import useUiConfig from 'hooks/api/getters/useUiConfig/useUiConfig';
import { InstancePrivacySection } from './InstancePrivacySection';
import { useTelemetry } from 'hooks/api/getters/useTelemetry/useTelemetry';
import { ConditionallyRender } from 'component/common/ConditionallyRender/ConditionallyRender';
interface IFeatureActivenessManagementInfo {
enabled: IActivenessManagementInfo;
@ -85,7 +84,7 @@ const featureCollectionActivenessManagementTexts: IFeatureActivenessManagementIn
export const InstancePrivacy = () => {
const { settings } = useTelemetry();
const { uiConfig, loading } = useUiConfig();
const { loading } = useUiConfig();
if (loading) {
return null;
@ -116,30 +115,17 @@ export const InstancePrivacy = () => {
changeInfoText={versionActivenessInfo.changeInfoText}
variablesText={versionActivenessInfo.environmentVariables}
/>
<ConditionallyRender
condition={Boolean(
uiConfig.flags.experimentalExtendedTelemetry
)}
show={
<InstancePrivacySection
title={featureCollectionDetails.title}
infoText={featureCollectionDetails.infoText}
concreteDetails={
featureCollectionDetails.concreteDetails
}
enabled={
settings?.featureInfoCollectionEnabled &&
settings?.versionInfoCollectionEnabled
}
changeInfoText={
featureActivenessInfo.changeInfoText
}
variablesText={
featureActivenessInfo.environmentVariables
}
dependsOnText={dependsOnFeatureCollection}
/>
<InstancePrivacySection
title={featureCollectionDetails.title}
infoText={featureCollectionDetails.infoText}
concreteDetails={featureCollectionDetails.concreteDetails}
enabled={
settings?.featureInfoCollectionEnabled &&
settings?.versionInfoCollectionEnabled
}
changeInfoText={featureActivenessInfo.changeInfoText}
variablesText={featureActivenessInfo.environmentVariables}
dependsOnText={dependsOnFeatureCollection}
/>
</StyledBox>
</PageContent>

View File

@ -54,7 +54,6 @@ export interface IFlags {
advancedPlayground?: boolean;
customRootRoles?: boolean;
strategySplittedButton?: boolean;
experimentalExtendedTelemetry?: boolean;
}
export interface IVersionInfo {

View File

@ -77,7 +77,6 @@ exports[`should create default config 1`] = `
"disableNotifications": false,
"embedProxy": true,
"embedProxyFrontend": true,
"experimentalExtendedTelemetry": false,
"featuresExportImport": true,
"googleAuthEnabled": false,
"groupRootRoles": false,
@ -111,7 +110,6 @@ exports[`should create default config 1`] = `
"disableNotifications": false,
"embedProxy": true,
"embedProxyFrontend": true,
"experimentalExtendedTelemetry": false,
"featuresExportImport": true,
"googleAuthEnabled": false,
"groupRootRoles": false,

View File

@ -54,10 +54,7 @@ class TelemetryController extends Controller {
telemetrySettingsSchema.$id,
{
versionInfoCollectionEnabled: this.config.versionCheck.enable,
featureInfoCollectionEnabled:
this.config.flagResolver.isEnabled(
'experimentalExtendedTelemetry',
) && this.config.telemetry,
featureInfoCollectionEnabled: this.config.telemetry,
},
);
}

View File

@ -14,21 +14,6 @@ afterAll(() => {
nock.enableNetConnect();
});
const getTestFlagResolver = (enabled: boolean) => {
return {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
isEnabled: () => {
return enabled;
},
getAll: () => {
return {};
},
getVariant: () => {
return { name: '', enabled: false };
},
};
};
test('yields current versions', async () => {
const url = `https://${randomId()}.example.com`;
const stores = createStores();
@ -49,7 +34,6 @@ test('yields current versions', async () => {
const service = new VersionService(stores, {
getLogger,
versionCheck: { url, enable: true },
flagResolver: getTestFlagResolver(true),
telemetry: true,
});
await service.checkLatestVersion();
@ -84,7 +68,6 @@ test('supports setting enterprise version as well', async () => {
getLogger,
versionCheck: { url, enable: true },
enterpriseVersion,
flagResolver: getTestFlagResolver(true),
telemetry: true,
});
await service.checkLatestVersion();
@ -119,7 +102,6 @@ test('if version check is not enabled should not make any calls', async () => {
getLogger,
versionCheck: { url, enable: false },
enterpriseVersion,
flagResolver: getTestFlagResolver(true),
telemetry: true,
});
await service.checkLatestVersion();
@ -162,7 +144,6 @@ test('sets featureinfo', async () => {
getLogger,
versionCheck: { url, enable: true },
enterpriseVersion,
flagResolver: getTestFlagResolver(true),
telemetry: true,
});
await service.checkLatestVersion();
@ -211,47 +192,6 @@ test('counts toggles', async () => {
getLogger,
versionCheck: { url, enable: true },
enterpriseVersion,
flagResolver: getTestFlagResolver(true),
telemetry: true,
});
await service.checkLatestVersion();
expect(scope.isDone()).toEqual(true);
nock.cleanAll();
});
test('doesnt report featureinfo when flag off', async () => {
const url = `https://${randomId()}.example.com`;
const stores = createStores();
const enterpriseVersion = '4.0.0';
await stores.settingStore.insert('instanceInfo', { id: '1234abc' });
await stores.settingStore.insert('unleash.enterprise.auth.oidc', {
enabled: true,
});
await stores.featureToggleStore.create('project', { name: uuidv4() });
await stores.strategyStore.createStrategy({
name: uuidv4(),
editable: true,
});
const latest = {
oss: '4.0.0',
enterprise: '4.0.0',
};
const scope = nock(url)
.post('/', (body) => body.featureInfo === undefined)
.reply(() => [
200,
JSON.stringify({
latest: true,
versions: latest,
}),
]);
const service = new VersionService(stores, {
getLogger,
versionCheck: { url, enable: true },
enterpriseVersion,
flagResolver: getTestFlagResolver(false),
telemetry: true,
});
await service.checkLatestVersion();
@ -314,7 +254,6 @@ test('counts custom strategies', async () => {
getLogger,
versionCheck: { url, enable: true },
enterpriseVersion,
flagResolver: getTestFlagResolver(true),
telemetry: true,
});
await service.checkLatestVersion();

View File

@ -19,7 +19,6 @@ import { ISettingStore } from '../types/stores/settings-store';
import { hoursToMilliseconds } from 'date-fns';
import { IStrategyStore } from 'lib/types';
import { FEATURES_EXPORTED, FEATURES_IMPORTED } from '../types';
import { IFlagResolver } from '../types';
export interface IVersionInfo {
oss: string;
@ -102,8 +101,6 @@ export default class VersionService {
private timer: NodeJS.Timeout;
private flagResolver: IFlagResolver;
constructor(
{
settingStore,
@ -137,15 +134,10 @@ export default class VersionService {
getLogger,
versionCheck,
enterpriseVersion,
flagResolver,
telemetry,
}: Pick<
IUnleashConfig,
| 'getLogger'
| 'versionCheck'
| 'enterpriseVersion'
| 'flagResolver'
| 'telemetry'
'getLogger' | 'versionCheck' | 'enterpriseVersion' | 'telemetry'
>,
) {
this.logger = getLogger('lib/services/version-service.js');
@ -169,7 +161,6 @@ export default class VersionService {
this.telemetryEnabled = telemetry;
this.versionCheckUrl = versionCheck.url;
this.isLatest = true;
this.flagResolver = flagResolver;
process.nextTick(() => this.setup());
}
@ -200,12 +191,7 @@ export default class VersionService {
instanceId: this.instanceId,
};
if (
this.flagResolver.isEnabled(
'experimentalExtendedTelemetry',
) &&
this.telemetryEnabled
) {
if (this.telemetryEnabled) {
const featureInfo = await this.getFeatureUsageInfo();
versionPayload.featureInfo = featureInfo;
}

View File

@ -20,7 +20,6 @@ export type IFlagKey =
| 'demo'
| 'googleAuthEnabled'
| 'disableBulkToggle'
| 'experimentalExtendedTelemetry'
| 'segmentContextFieldUsage'
| 'disableNotifications'
| 'advancedPlayground'
@ -94,10 +93,6 @@ const flags: IFlags = {
process.env.GOOGLE_AUTH_ENABLED,
false,
),
experimentalExtendedTelemetry: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_EXTENDED_TELEMETRY,
false,
),
disableBulkToggle: parseEnvVarBoolean(
process.env.DISABLE_BULK_TOGGLE,
false,