1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-11 00:08:30 +01:00

fix: don't clean up settings when optional data is not present (#5118)

## About the changes
This fixes a bug updating a project, when optional data
(defaultStickiness and featureLimit are not part of the payload).

The problem happens due to:
1. ProjectController does not use the type: UpdateProjectSchema for the
request body (will be addressed in another PR in unleash-enterprise)
2. Project Store interface does not match UpdateProjectSchema (but it
relies on accepting `additional properties: true`, which is what we
agreed on for input)
3. Feature limit is not defined in UpdateProjectSchema (also addressed
in the other PR)
This commit is contained in:
Gastón Fournier 2023-10-23 10:15:25 +02:00 committed by GitHub
parent 34395d3ef9
commit 2aebc8c58e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 37 additions and 14 deletions

View File

@ -6,6 +6,7 @@ import {
IEnvironment, IEnvironment,
IFlagResolver, IFlagResolver,
IProject, IProject,
IProjectUpdate,
IProjectWithCount, IProjectWithCount,
ProjectMode, ProjectMode,
} from '../types'; } from '../types';
@ -259,25 +260,30 @@ class ProjectStore implements IProjectStore {
return present; return present;
} }
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types async update(data: IProjectUpdate): Promise<void> {
async update(data): Promise<void> {
try { try {
await this.db(TABLE) await this.db(TABLE)
.where({ id: data.id }) .where({ id: data.id })
.update(this.fieldToRow(data)); .update(this.fieldToRow(data));
if (await this.hasProjectSettings(data.id)) { if (
await this.db(SETTINGS_TABLE) data.defaultStickiness !== undefined ||
.where({ project: data.id }) data.featureLimit !== undefined
.update({ ) {
if (await this.hasProjectSettings(data.id)) {
await this.db(SETTINGS_TABLE)
.where({ project: data.id })
.update({
default_stickiness: data.defaultStickiness,
feature_limit: data.featureLimit,
});
} else {
// What happens with project mode in this case?
await this.db(SETTINGS_TABLE).insert({
project: data.id,
default_stickiness: data.defaultStickiness, default_stickiness: data.defaultStickiness,
feature_limit: data.featureLimit, feature_limit: data.featureLimit,
}); });
} else { }
await this.db(SETTINGS_TABLE).insert({
project: data.id,
default_stickiness: data.defaultStickiness,
feature_limit: data.featureLimit,
});
} }
} catch (err) { } catch (err) {
this.logger.error('Could not update project, error: ', err); this.logger.error('Could not update project, error: ', err);

View File

@ -39,6 +39,7 @@ import {
ProjectAccessUserRolesDeleted, ProjectAccessUserRolesDeleted,
IFeatureNaming, IFeatureNaming,
CreateProject, CreateProject,
IProjectUpdate,
} from '../types'; } from '../types';
import { import {
IProjectQuery, IProjectQuery,
@ -259,16 +260,22 @@ export default class ProjectService {
return data; return data;
} }
async updateProject(updatedProject: IProject, user: IUser): Promise<void> { async updateProject(
updatedProject: IProjectUpdate,
user: IUser,
): Promise<void> {
const preData = await this.projectStore.get(updatedProject.id); const preData = await this.projectStore.get(updatedProject.id);
await this.projectStore.update(updatedProject); await this.projectStore.update(updatedProject);
// updated project contains instructions to update the project but it may not represent a whole project
const afterData = await this.projectStore.get(updatedProject.id);
await this.eventStore.store({ await this.eventStore.store({
type: PROJECT_UPDATED, type: PROJECT_UPDATED,
project: updatedProject.id, project: updatedProject.id,
createdBy: getCreatedBy(user), createdBy: getCreatedBy(user),
data: updatedProject, data: afterData,
preData, preData,
}); });
} }

View File

@ -449,6 +449,16 @@ export interface IProject {
featureNaming?: IFeatureNaming; featureNaming?: IFeatureNaming;
} }
// mimics UpdateProjectSchema
export interface IProjectUpdate {
id: string;
name: string;
description?: string;
mode?: ProjectMode;
defaultStickiness?: string;
featureLimit?: number;
}
/** /**
* Extends IRole making description mandatory * Extends IRole making description mandatory
*/ */