Merge pull request #41108 from appsmithorg/release

14/07 Daily Promotion

Author: btsgh

app/client/src/WidgetProvider/factory/__tests__/WidgetFactory.test.ts

@@ -0,0 +1,39 @@
+import WidgetFactory from "../index";
+import { clearAllWidgetFactoryCache } from "../decorators";
+import type BaseWidget from "widgets/BaseWidget";
+
+describe("WidgetFactory Cache Tests", () => {
+  beforeAll(() => {
+    // Clear the widget factory state before each test
+    WidgetFactory.widgetsMap.clear();
+    clearAllWidgetFactoryCache();
+  });
+
+  afterAll(() => {
+    // Clean up after each test
+    WidgetFactory.widgetsMap.clear();
+    clearAllWidgetFactoryCache();
+  });
+
+  it("should return stale data after widget registration until cache is cleared", () => {
+    // Initial state - no widgets
+    let widgetTypes = WidgetFactory.getWidgetTypes();
+
+    expect(widgetTypes).toEqual([]);
+
+    // Add a widget to the map
+    WidgetFactory.widgetsMap.set("TEST_WIDGET", {} as typeof BaseWidget);
+
+    // getWidgetTypes should still return empty array (stale cache)
+    widgetTypes = WidgetFactory.getWidgetTypes();
+    expect(widgetTypes).toEqual([]);
+
+    // Clear the cache
+    clearAllWidgetFactoryCache();
+
+    // Now getWidgetTypes should return the updated widget type
+    widgetTypes = WidgetFactory.getWidgetTypes();
+    expect(widgetTypes).toContain("TEST_WIDGET");
+    expect(widgetTypes).toHaveLength(1);
+  });
+});

app/client/src/WidgetProvider/factory/decorators.ts

@@ -1,13 +1,47 @@
 import memo from "micro-memoize";
 
+type AnyFn = (...args: unknown[]) => unknown;
+
+interface MemoizedWithClear {
+  (...args: unknown[]): unknown;
+  clearCache: () => void;
+}
+
+// Track all memoized functions
+const memoizedFunctions = new Set<MemoizedWithClear>();
+
+// Function to clear memoized cache
+function clearMemoizedCache(fn: {
+  cache: { keys: unknown[]; values: unknown[] };
+}) {
+  fn.cache.keys.length = fn.cache.values.length = 0;
+}
+
+// Create a memoize wrapper that adds cache clearing capability
+function memoizeWithClear(fn: AnyFn): MemoizedWithClear {
+  const memoized = memo(fn, {
+    maxSize: 100,
+  }) as unknown as MemoizedWithClear;
+
+  // Add clearCache method to the memoized function
+  memoized.clearCache = () => {
+    clearMemoizedCache(
+      memoized as unknown as { cache: { keys: unknown[]; values: unknown[] } },
+    );
+  };
+
+  // Add to tracked functions
+  memoizedFunctions.add(memoized);
+
+  return memoized;
+}
+
 export function memoize(
   target: unknown,
   methodName: unknown,
   descriptor: PropertyDescriptor,
 ) {
-  descriptor.value = memo(descriptor.value, {
-    maxSize: 100,
-  });
+  descriptor.value = memoizeWithClear(descriptor.value);
 }
 
 export function freeze(
@@ -25,3 +59,8 @@ export function freeze(
     return Object.freeze(result);
   };
 }
+
+// Function to clear all memoized caches
+export function clearAllWidgetFactoryCache() {
+  memoizedFunctions.forEach((fn) => fn.clearCache());
+}

app/client/src/WidgetProvider/factory/registrationHelper.tsx

@@ -3,6 +3,7 @@ import type { CanvasWidgetStructure } from "WidgetProvider/types";
 import type BaseWidget from "widgets/BaseWidget";
 import WidgetFactory from ".";
 import { withBaseWidgetHOC } from "widgets/BaseWidgetHOC/withBaseWidgetHOC";
+import { incrementWidgetConfigsVersion } from "./widgetConfigVersion";
 
 /*
  * Function to create builder for the widgets and register them in widget factory
@@ -11,28 +12,31 @@ import { withBaseWidgetHOC } from "widgets/BaseWidgetHOC/withBaseWidgetHOC";
  * extracted this into a seperate file to break the circular reference.
  *
  */
+
 export const registerWidgets = (widgets: (typeof BaseWidget)[]) => {
-  const widgetAndBuilders = widgets.map((widget) => {
-    const { eagerRender = false, needsMeta = false } = widget.getConfig();
+  widgets.forEach((widget) => {
+    registerWidget(widget);
+  });
+  // Increment version to trigger selectors that depend on widget configs
+  incrementWidgetConfigsVersion();
+};
 
-    // TODO: Fix this the next time the file is edited
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const ProfiledWidget: any = withBaseWidgetHOC(
-      widget,
-      needsMeta,
-      eagerRender,
-    );
+export const registerWidget = (widget: typeof BaseWidget) => {
+  const { eagerRender = false, needsMeta = false } = widget.getConfig();
 
-    return [
-      widget,
-      (widgetProps: CanvasWidgetStructure) => (
-        <ProfiledWidget {...widgetProps} key={widgetProps.widgetId} />
-      ),
-    ] as [
-      typeof BaseWidget,
-      (widgetProps: CanvasWidgetStructure) => React.ReactNode,
-    ];
-  });
+  // TODO: Fix this the next time the file is edited
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const ProfiledWidget: any = withBaseWidgetHOC(widget, needsMeta, eagerRender);
+
+  const widgetAndBuilder: [
+    typeof BaseWidget,
+    (widgetProps: CanvasWidgetStructure) => React.ReactNode,
+  ] = [
+    widget,
+    (widgetProps: CanvasWidgetStructure) => (
+      <ProfiledWidget {...widgetProps} key={widgetProps.widgetId} />
+    ),
+  ];
 
-  WidgetFactory.initialize(widgetAndBuilders);
+  WidgetFactory.initialize([widgetAndBuilder]);
 };

app/client/src/WidgetProvider/factory/widgetConfigVersion.ts

@@ -0,0 +1,10 @@
+// Global version counter that increments when widgets are registered
+let widgetConfigsVersion = 0;
+
+// Export getter for selectors to depend on
+export const getWidgetConfigsVersion = () => widgetConfigsVersion;
+
+// Export incrementer for registration helper to use
+export const incrementWidgetConfigsVersion = () => {
+  widgetConfigsVersion++;
+};

app/client/src/actions/JSLibraryActions.ts

@@ -12,6 +12,16 @@ export function fetchJSLibraries(
   };
 }
 
+export function deferLoadingJSLibraries(
+  applicationId: string,
+  customJSLibraries?: ApiResponse,
+) {
+  return {
+    type: ReduxActionTypes.DEFER_LOADING_JS_LIBRARIES,
+    payload: { applicationId, customJSLibraries },
+  };
+}
+
 export function installLibraryInit(payload: Partial<JSLibrary>) {
   return {
     type: ReduxActionTypes.INSTALL_LIBRARY_INIT,

app/client/src/actions/evaluationActions.ts

@@ -13,6 +13,7 @@ import type {
   ConditionalOutput,
   DynamicValues,
 } from "reducers/evaluationReducers/formEvaluationReducer";
+import type { ReduxActionWithoutPayload } from "./ReduxActionTypes";
 
 export const shouldTriggerEvaluation = (action: ReduxAction<unknown>) => {
   return (
@@ -79,6 +80,12 @@ export const setDependencyMap = (
   };
 };
 
+export const setIsFirstPageLoad = (): ReduxActionWithoutPayload => {
+  return {
+    type: ReduxActionTypes.IS_FIRST_PAGE_LOAD,
+  };
+};
+
 // These actions require the entire tree to be re-evaluated
 const FORCE_EVAL_ACTIONS = {
   [ReduxActionTypes.INSTALL_LIBRARY_SUCCESS]: true,

app/client/src/ce/constants/ReduxActionConstants.tsx

@@ -14,6 +14,7 @@ const JSLibraryActionTypes = {
   TOGGLE_INSTALLER: "TOGGLE_INSTALLER",
   FETCH_JS_LIBRARIES_INIT: "FETCH_JS_LIBRARIES_INIT",
   FETCH_JS_LIBRARIES_SUCCESS: "FETCH_JS_LIBRARIES_SUCCESS",
+  DEFER_LOADING_JS_LIBRARIES: "DEFER_LOADING_JS_LIBRARIES",
   CLEAR_PROCESSED_INSTALLS: "CLEAR_PROCESSED_INSTALLS",
   INSTALL_LIBRARY_INIT: "INSTALL_LIBRARY_INIT",
   INSTALL_LIBRARY_START: "INSTALL_LIBRARY_START",
@@ -1288,7 +1289,15 @@ const PlatformActionErrorTypes = {
   API_ERROR: "API_ERROR",
 };
 
+const DeferRenderingAppViewerActionTypes = {
+  HAS_DISPATCHED_FIRST_EVALUATION_MESSAGE:
+    "HAS_DISPATCHED_FIRST_EVALUATION_MESSAGE",
+  RENDER_PAGE: "RENDER_PAGE",
+  IS_FIRST_PAGE_LOAD: "IS_FIRST_PAGE_LOAD",
+};
+
 export const ReduxActionTypes = {
+  ...DeferRenderingAppViewerActionTypes,
   ...ActionActionTypes,
   ...AdminSettingsActionTypes,
   ...AnalyticsActionTypes,

app/client/src/ce/reducers/index.tsx

@@ -70,6 +70,7 @@ import type { layoutConversionReduxState } from "reducers/uiReducers/layoutConve
 import type { OneClickBindingState } from "reducers/uiReducers/oneClickBindingReducer";
 import type { IDEState } from "reducers/uiReducers/ideReducer";
 import type { PluginActionEditorState } from "PluginActionEditor";
+import type { FirstEvaluationState } from "reducers/evaluationReducers/firstEvaluationReducer";
 
 /* Reducers which are integrated into the core system when registering a pluggable module
     or done so by a module that is designed to be eventually pluggable */
@@ -171,6 +172,7 @@ export interface AppState {
     loadingEntities: LoadingEntitiesState;
     formEvaluation: FormEvaluationState;
     triggers: TriggerValuesEvaluationState;
+    firstEvaluation: FirstEvaluationState;
   };
   linting: {
     errors: LintErrorsStore;

app/client/src/ce/sagas/PageSagas.tsx

@@ -157,6 +157,7 @@ import { apiFailureResponseInterceptor } from "api/interceptors/response";
 import type { AxiosError } from "axios";
 import { handleFetchApplicationError } from "./ApplicationSagas";
 import { getCurrentUser } from "actions/authActions";
+import { getIsFirstPageLoad } from "selectors/evaluationSelectors";
 
 export interface HandleWidgetNameUpdatePayload {
   newName: string;
@@ -370,8 +371,14 @@ export function* postFetchedPublishedPage(
       response.data.userPermissions,
     ),
   );
-  // Clear any existing caches
-  yield call(clearEvalCache);
+  const isFirstLoad: boolean = yield select(getIsFirstPageLoad);
+
+  // Only the first page load we defer the clearing of caches
+  if (!isFirstLoad) {
+    // Clear any existing caches
+    yield call(clearEvalCache);
+  }
+
   // Set url params
   yield call(setDataUrl);
 

app/client/src/ce/selectors/moduleInstanceSelectors.ts

@@ -14,3 +14,6 @@ export const getModuleInstanceJSCollectionById = (
 ): JSCollection | undefined => {
   return undefined;
 };
+export const getAllUniqueWidgetTypesInUiModules = (state: DefaultRootState) => {
+  return [];
+};