## Description This PR includes changes for renaming design system package. Since we are building new package for the refactored design system components, the old package is renaming to design-system-old. Fixes #19536 ## Type of change - New feature (non-breaking change which adds functionality) - Breaking change (fix or feature that would cause existing functionality to not work as expected) ## How Has This Been Tested? - Manual - Jest - Cypress ### Test Plan > Add Testsmith test cases links that relate to this PR ### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) ## Checklist: ### Dev activity - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag ### QA activity: - [ ] Test plan has been approved by relevant developers - [ ] Test plan has been peer reviewed by QA - [ ] Cypress test cases have been added and approved by either SDET or manual QA - [ ] Organized project review call with relevant stakeholders after Round 1/2 of QA - [ ] Added Test Plan Approved label after reveiwing all Cypress test
130 lines
3.0 KiB
TypeScript
130 lines
3.0 KiB
TypeScript
import { Toaster, Variant } from "design-system-old";
|
|
import * as log from "loglevel";
|
|
import {
|
|
LOCAL_STORAGE_QUOTA_EXCEEDED_MESSAGE,
|
|
LOCAL_STORAGE_NO_SPACE_LEFT_ON_DEVICE_MESSAGE,
|
|
LOCAL_STORAGE_NOT_SUPPORTED_APP_MIGHT_NOT_WORK_AS_EXPECTED,
|
|
createMessage,
|
|
} from "@appsmith/constants/messages";
|
|
|
|
export const LOCAL_STORAGE_KEYS = {
|
|
CANVAS_CARDS_STATE: "CANVAS_CARDS_STATE",
|
|
};
|
|
|
|
class LocalStorageNotSupportedError extends Error {
|
|
name: string;
|
|
constructor() {
|
|
super();
|
|
this.name = "LOCAL_STORAGE_NOT_SUPPORTED";
|
|
}
|
|
}
|
|
|
|
class WebStorage {
|
|
private storage: Storage;
|
|
private _isSupported: boolean;
|
|
|
|
constructor(storage: Storage) {
|
|
this.storage = storage;
|
|
|
|
this._isSupported = this.isSupported();
|
|
}
|
|
// ref: https://github.com/Modernizr/Modernizr/blob/94592f279a410436530c7c06acc42a6e90c20150/feature-detects/storage/localstorage.js
|
|
isSupported = () => {
|
|
try {
|
|
this.storage.setItem("test", "testA");
|
|
this.storage.removeItem("test");
|
|
return true;
|
|
} catch (e) {
|
|
return false;
|
|
}
|
|
};
|
|
|
|
getItem = (key: string): string | null => {
|
|
try {
|
|
if (!this._isSupported) {
|
|
throw new LocalStorageNotSupportedError();
|
|
}
|
|
return this.storage.getItem(key);
|
|
} catch (error) {
|
|
this.handleError(error as Error);
|
|
}
|
|
return null;
|
|
};
|
|
|
|
handleError = (e: Error) => {
|
|
let message;
|
|
if (e.name === "QuotaExceededError") {
|
|
message = LOCAL_STORAGE_QUOTA_EXCEEDED_MESSAGE;
|
|
} else if (e.name === "NS_ERROR_FILE_NO_DEVICE_SPACE") {
|
|
message = LOCAL_STORAGE_NO_SPACE_LEFT_ON_DEVICE_MESSAGE;
|
|
} else if (e.name === "LOCAL_STORAGE_NOT_SUPPORTED") {
|
|
// Fail silently
|
|
log.error(
|
|
createMessage(
|
|
LOCAL_STORAGE_NOT_SUPPORTED_APP_MIGHT_NOT_WORK_AS_EXPECTED,
|
|
),
|
|
);
|
|
return;
|
|
}
|
|
|
|
if (message) {
|
|
Toaster.show({
|
|
text: createMessage(message),
|
|
variant: Variant.danger,
|
|
});
|
|
} else {
|
|
throw e;
|
|
}
|
|
};
|
|
|
|
setItem = (key: string, value: string) => {
|
|
try {
|
|
if (!this._isSupported) {
|
|
throw new LocalStorageNotSupportedError();
|
|
}
|
|
this.storage.setItem(key, value);
|
|
} catch (error) {
|
|
this.handleError(error as Error);
|
|
}
|
|
};
|
|
|
|
removeItem = (key: string) => {
|
|
try {
|
|
if (!this._isSupported) {
|
|
throw new LocalStorageNotSupportedError();
|
|
}
|
|
this.storage.removeItem(key);
|
|
} catch (error) {
|
|
this.handleError(error as Error);
|
|
}
|
|
};
|
|
|
|
clear = () => {
|
|
try {
|
|
if (!this._isSupported) {
|
|
throw new LocalStorageNotSupportedError();
|
|
}
|
|
this.storage.clear();
|
|
} catch (error) {
|
|
this.handleError(error as Error);
|
|
}
|
|
};
|
|
}
|
|
|
|
export class LocalStorage extends WebStorage {
|
|
constructor() {
|
|
super(window.localStorage);
|
|
}
|
|
}
|
|
|
|
class SessionStorage extends WebStorage {
|
|
constructor() {
|
|
super(window.sessionStorage);
|
|
}
|
|
}
|
|
|
|
const localStorage = new LocalStorage();
|
|
export const sessionStorage = new SessionStorage();
|
|
|
|
export default localStorage;
|