Protei/PromucFlow_constructor
2
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore: Remove unneeded fields in snapshot response body (#32813)

Browse Source 
These extra fields don't hold much semantic value, and are completely
ignored by the client. This PR removes them and only keeps the one field
that's used by the client.


/ok-to-test tags="@tag.All"<!-- This is an auto-generated comment:
Cypress test results -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/8755978321>
> Commit: 9b680799db0d30fb56c908f02260abbb4b590ac3
> Cypress dashboard url: <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=8755978321&attempt=2"
target="_blank">Click here!</a>

<!-- end of auto-generated comment: Cypress test results  -->










<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Refactor**
- Improved consistency in naming conventions related to snapshot details
across the platform.
- Enhanced data handling in snapshot fetching and updating processes for
better performance.
- Streamlined snapshot-related data structures and service responses to
focus on relevant information.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
Shrikant Sharat Kandula 2024-04-22 08:08:45 +05:30 committed by GitHub
parent 946e69bbd2
commit 9649d8561c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 15 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
app/client/src/actions/autoLayoutActions.ts
View File

@ -3,7 +3,7 @@ import type { LayoutSystemTypes } from "layoutSystems/types";
import type { CanvasWidgetsReduxState } from "reducers/entityReducers/canvasWidgetsReducer";
import type {
CONVERSION_STATES,
SnapShotDetails,
SnapshotDetails,
} from "reducers/uiReducers/layoutConversionReducer";
/**
@ -46,11 +46,11 @@ export const setLayoutConversionStateAction = (
};
export const updateSnapshotDetails = (
snapShotDetails: SnapShotDetails | undefined,
snapshotDetails: SnapshotDetails | undefined,
) => {
return {
type: ReduxActionTypes.UPDATE_SNAPSHOT_DETAILS,
payload: snapShotDetails,
payload: snapshotDetails,
};
};
export function updateWidgetDimensionAction(

8
app/client/src/reducers/uiReducers/layoutConversionReducer.ts
View File

@ -21,8 +21,8 @@ export enum CONVERSION_STATES {
RESTORING_SNAPSHOT_SPINNER = "RESTORING_SNAPSHOT_SPINNER",
}
export interface SnapShotDetails {
lastUpdatedTime: string;
export interface SnapshotDetails {
updatedTime: string;
}
const initialState: layoutConversionReduxState = {
@ -58,14 +58,14 @@ const layoutConversionReducer = createImmerReducer(initialState, {
},
[ReduxActionTypes.UPDATE_SNAPSHOT_DETAILS]: (
state: layoutConversionReduxState,
action: ReduxAction<SnapShotDetails | undefined>,
action: ReduxAction<SnapshotDetails | undefined>,
) => {
state.snapshotDetails = action.payload;
},
});
export interface layoutConversionReduxState {
snapshotDetails: SnapShotDetails | undefined;
snapshotDetails: SnapshotDetails | undefined;
conversionError: Error | undefined;
conversionState: CONVERSION_STATES;
isConverting: boolean;

18
app/client/src/sagas/SnapshotSagas.ts
View File

@ -7,7 +7,7 @@ import ApplicationApi from "@appsmith/api/ApplicationApi";
import type { PageDefaultMeta } from "@appsmith/api/ApplicationApi";
import { ReduxActionTypes } from "@appsmith/constants/ReduxActionConstants";
import log from "loglevel";
import type { SnapShotDetails } from "reducers/uiReducers/layoutConversionReducer";
import type { SnapshotDetails } from "reducers/uiReducers/layoutConversionReducer";
import { CONVERSION_STATES } from "reducers/uiReducers/layoutConversionReducer";
import { all, call, put, select, takeLatest } from "redux-saga/effects";
import { getCurrentApplicationId } from "selectors/editorSelectors";
@ -43,7 +43,7 @@ export function* createSnapshotSaga() {
//Saga to fetch application snapshot
export function* fetchSnapshotSaga() {
let response: ApiResponse<SnapShotDetails> | undefined;
let response: ApiResponse<SnapshotDetails> | undefined;
try {
const applicationId: string = yield select(getCurrentApplicationId);
response = yield ApplicationApi.getSnapShotDetails({
@ -57,9 +57,7 @@ export function* fetchSnapshotSaga() {
);
if (isValidResponse) {
const snapShotDetails = response?.data;
return snapShotDetails;
return response?.data;
}
} catch (error) {
if (getLogToSentryFromResponse(response)) {
@ -169,15 +167,9 @@ export function* deleteApplicationSnapshotSaga() {
//Saga to update snapshot details by fetching info from backend
function* updateSnapshotDetailsSaga() {
try {
const snapShotDetails: { updatedTime: Date } | undefined =
const snapshotDetails: SnapshotDetails | undefined =
yield call(fetchSnapshotSaga);
yield put(
updateSnapshotDetails(
snapShotDetails && snapShotDetails.updatedTime
? { lastUpdatedTime: snapShotDetails.updatedTime?.toString() }
: undefined,
),
);
yield put(updateSnapshotDetails(snapshotDetails));
} catch (error) {
throw error;
}

2
app/client/src/selectors/autoLayoutSelectors.tsx
View File

@ -25,7 +25,7 @@ export const getFlexLayers = (parentId: string) => {
};
export const getSnapshotUpdatedTime = (state: AppState) =>
state.ui.layoutConversion.snapshotDetails?.lastUpdatedTime;
state.ui.layoutConversion.snapshotDetails?.updatedTime;
export const getLayerIndex = (widgetId: string, parentId: string) => {
return createSelector(

21
app/server/appsmith-server/src/main/java/com/appsmith/server/projections/ApplicationSnapshotResponseDTO.java
View File

@ -5,29 +5,10 @@ import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import java.time.Instant;
import java.util.Collections;
import java.util.List;
public record ApplicationSnapshotResponseDTO(
@JsonIgnore String id, int chunkOrder, @JsonIgnore Instant updatedAt, @JsonIgnore Instant createdAt) {
public ApplicationSnapshotResponseDTO() {
this(null, 0, null, null);
}
@JsonInclude
public boolean isNew() {
return id == null;
}
public record ApplicationSnapshotResponseDTO(@JsonIgnore Instant updatedAt) {
@JsonInclude
public String getUpdatedTime() {
return updatedAt == null ? null : DateUtils.ISO_FORMATTER.format(updatedAt);
}
// Likely not used by the client. Verify and remove if not needed.
@JsonInclude
public List<?> getUserPermissions() {
return Collections.emptyList();
}
}

2
app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/ApplicationSnapshotServiceCEImpl.java
View File

@ -74,7 +74,7 @@ public class ApplicationSnapshotServiceCEImpl implements ApplicationSnapshotServ
.findBranchedApplicationId(branchName, applicationId, applicationPermission.getEditPermission())
.flatMap(branchedApplicationId ->
applicationSnapshotRepository.findByApplicationIdAndChunkOrder(branchedApplicationId, 1))
.defaultIfEmpty(new ApplicationSnapshotResponseDTO());
.defaultIfEmpty(new ApplicationSnapshotResponseDTO(null));
}
@Override

2
app/server/appsmith-server/src/test/java/com/appsmith/server/repositories/ApplicationSnapshotRepositoryTest.java
View File

@ -42,7 +42,6 @@ public class ApplicationSnapshotRepositoryTest {
StepVerifier.create(snapshotMono)
.assertNext(applicationSnapshot -> {
assertThat(applicationSnapshot.updatedAt()).isNotNull();
assertThat(applicationSnapshot.createdAt()).isNotNull();
})
.verifyComplete();
}
@ -67,7 +66,6 @@ public class ApplicationSnapshotRepositoryTest {
StepVerifier.create(snapshotMono)
.assertNext(applicationSnapshot -> {
assertThat(applicationSnapshot.createdAt()).isNotNull();
assertThat(applicationSnapshot.updatedAt()).isNotNull();
})
.verifyComplete();

3
app/server/appsmith-server/src/test/java/com/appsmith/server/services/ApplicationSnapshotServiceTest.java
View File

@ -106,7 +106,6 @@ public class ApplicationSnapshotServiceTest {
StepVerifier.create(snapshotMono)
.assertNext(snapshot -> {
assertThat(snapshot.updatedAt()).isNotNull();
assertThat(snapshot.createdAt()).isNotNull();
})
.verifyComplete();
}
@ -133,7 +132,6 @@ public class ApplicationSnapshotServiceTest {
StepVerifier.create(snapshotMono)
.assertNext(snapshot -> {
assertThat(snapshot.updatedAt()).isNotNull();
assertThat(snapshot.createdAt()).isNotNull();
})
.verifyComplete();
}
@ -165,7 +163,6 @@ public class ApplicationSnapshotServiceTest {
.assertNext(objects -> {
ApplicationSnapshotResponseDTO applicationSnapshot = objects.getT1();
assertThat(applicationSnapshot.updatedAt()).isNotNull();
assertThat(applicationSnapshot.createdAt()).isNotNull();
})
.verifyComplete();
}