Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: render segments changes in feature strategy update event messages #4950

Merged
merged 2 commits into from
Oct 9, 2023
Merged

feat: render segments changes in feature strategy update event messages #4950

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be91bb6
fix: add pre-change segment list as preData for feature strategy upda…
daveleek Oct 6, 2023
0c9bbf2
feat: format segment preData and data changes in event formatting
daveleek Oct 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 39 additions & 5 deletions src/lib/addons/feature-event-formatter-md.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,11 @@ export class FeatureEventFormatterMd implements FeatureEventFormatter {
preData?.constraints,
data?.constraints,
);
const strategySpecificText = [usersText, constraintText]
const segmentsText = this.segmentsChangeText(
preData?.segments,
data?.segments,
);
const strategySpecificText = [usersText, constraintText, segmentsText]
.filter((x) => x.length)
.join(';');
return `by updating strategy *${this.getStrategyTitle(
Expand Down Expand Up @@ -453,11 +457,16 @@ export class FeatureEventFormatterMd implements FeatureEventFormatter {
preData?.constraints,
data?.constraints,
);
const segmentsText = this.segmentsChangeText(
preData?.segments,
data?.segments,
);
const strategySpecificText = [
stickinessText,
rolloutText,
groupIdText,
constraintText,
segmentsText,
]
.filter((txt) => txt.length)
.join(';');
Expand All @@ -468,12 +477,20 @@ export class FeatureEventFormatterMd implements FeatureEventFormatter {

private defaultStrategyChangeText(event: IEvent) {
const { preData, data, environment } = event;
return `by updating strategy *${this.getStrategyTitle(
event,
)}* in *${environment}*${this.constraintChangeText(
const constraintText = this.constraintChangeText(
preData?.constraints,
data?.constraints,
)}`;
);
const segmentsText = this.segmentsChangeText(
preData?.segments,
data?.segments,
);
const strategySpecificText = [constraintText, segmentsText]
.filter((txt) => txt.length)
.join(';');
return `by updating strategy *${this.getStrategyTitle(
event,
)}* in *${environment}*${strategySpecificText}`;
}

private constraintChangeText(
Expand Down Expand Up @@ -525,6 +542,23 @@ export class FeatureEventFormatterMd implements FeatureEventFormatter {
: ` constraints from ${oldConstraintText} to ${newConstraintText}`;
}

private segmentsChangeText(
oldSegments: string[] = [],
newSegments: string[] = [],
) {
const formatSegments = (segments: string[]) => {
return segments.length === 0
? 'empty set of segments'
: `(${segments.join(',')})`;
};
const oldSegmentsText = formatSegments(oldSegments);
const newSegmentsText = formatSegments(newSegments);

return oldSegmentsText === newSegmentsText
? ''
: ` segments from ${oldSegmentsText} to ${newSegmentsText}`;
}

format(event: IEvent): {
text: string;
url?: string;
Expand Down
8 changes: 6 additions & 2 deletions src/lib/services/feature-toggle-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -704,6 +704,7 @@ class FeatureToggleService {
projectId,
updates.segments,
);
const existingSegments = await this.segmentService.getByStrategy(id);

if (existingStrategy.id === id) {
if (updates.constraints && updates.constraints.length > 0) {
Expand Down Expand Up @@ -738,7 +739,7 @@ class FeatureToggleService {
const data = this.featureStrategyToPublic(strategy, segments);
const preData = this.featureStrategyToPublic(
existingStrategy,
segments,
existingSegments,
);
await this.eventService.storeEvent(
new FeatureStrategyUpdateEvent({
Expand Down Expand Up @@ -775,6 +776,9 @@ class FeatureToggleService {

if (existingStrategy.id === id) {
existingStrategy.parameters[name] = String(value);
const existingSegments = await this.segmentService.getByStrategy(
id,
);
const strategy = await this.featureStrategiesStore.updateStrategy(
id,
existingStrategy,
Expand All @@ -785,7 +789,7 @@ class FeatureToggleService {
const data = this.featureStrategyToPublic(strategy, segments);
const preData = this.featureStrategyToPublic(
existingStrategy,
segments,
existingSegments,
);
await this.eventService.storeEvent(
new FeatureStrategyUpdateEvent({
Expand Down