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: Read settings from props/server config when available #1558

Merged
merged 27 commits into from
Nov 9, 2023
Merged

feat: Read settings from props/server config when available #1558

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
20602fa
init
Zhou-Ziheng Oct 4, 2023
f058868
interesting
Zhou-Ziheng Oct 11, 2023
e5c9794
Merge remote-tracking branch 'origin/main' into use_server_config
Zhou-Ziheng Oct 11, 2023
6616fc2
sus
Zhou-Ziheng Oct 29, 2023
0985974
Merge remote-tracking branch 'origin/main' into use_server_config
Zhou-Ziheng Oct 29, 2023
c4ba548
sus
Zhou-Ziheng Oct 30, 2023
6dc09d8
fixed types
Zhou-Ziheng Oct 30, 2023
c1ecd97
tests
Zhou-Ziheng Oct 30, 2023
f17a4b7
types
Zhou-Ziheng Oct 30, 2023
6fa97f4
sus3
Zhou-Ziheng Oct 30, 2023
b54cbbc
types
Zhou-Ziheng Oct 31, 2023
e9aa8bc
only inject when getSettings
Zhou-Ziheng Nov 8, 2023
dfdba6d
update optional
Zhou-Ziheng Nov 8, 2023
9c28f30
debounce commit changes
Zhou-Ziheng Nov 8, 2023
532ca85
debounce
Zhou-Ziheng Nov 8, 2023
bad34f1
Merge remote-tracking branch 'origin/main' into use_server_config
Zhou-Ziheng Nov 8, 2023
4149f4f
assertions
Zhou-Ziheng Nov 8, 2023
c7baa09
weird redux issue
Zhou-Ziheng Nov 8, 2023
8335a0b
weird redux issue
Zhou-Ziheng Nov 8, 2023
8c615ac
deep copy
Zhou-Ziheng Nov 8, 2023
2f1008c
why did I add this
Zhou-Ziheng Nov 8, 2023
6e8044d
yikes
Zhou-Ziheng Nov 8, 2023
83b0925
ts
Zhou-Ziheng Nov 8, 2023
69f6579
more ts
Zhou-Ziheng Nov 8, 2023
99f8a4b
clean code
Zhou-Ziheng Nov 8, 2023
7bb79c4
requested changes
Zhou-Ziheng Nov 9, 2023
4e06b30
Merge remote-tracking branch 'origin/main' into use_server_config
Zhou-Ziheng Nov 9, 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
9 changes: 6 additions & 3 deletions packages/code-studio/src/main/AppInit.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,9 +145,12 @@ function AppInit(props: AppInitProps): JSX.Element {
const workspaceStorage = new LocalWorkspaceStorage(layoutStorage);
const commandHistoryStorage = new PouchCommandHistoryStorage();

const loadedWorkspace = await workspaceStorage.load({
isConsoleAvailable: sessionWrapper !== undefined,
});
const loadedWorkspace = await workspaceStorage.load(
{
isConsoleAvailable: sessionWrapper !== undefined,
},
serverConfig
);

const { data } = loadedWorkspace;

Expand Down
62 changes: 50 additions & 12 deletions packages/code-studio/src/storage/LocalWorkspaceStorage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,34 +21,66 @@ const log = Log.module('LocalWorkspaceStorage');
export class LocalWorkspaceStorage implements WorkspaceStorage {
static readonly STORAGE_KEY = 'deephaven.WorkspaceStorage';

static getServerConfigValueOrUseDefault<T>(
serverConfigValues: Map<string, string> | undefined,
key: string,
defaultValue: T
): string | T {
if (serverConfigValues && serverConfigValues.has(key)) {
return serverConfigValues.get(key) ?? defaultValue;
}
return defaultValue;
}

static async makeDefaultWorkspaceData(
layoutStorage: LayoutStorage,
options?: WorkspaceStorageLoadOptions
options?: WorkspaceStorageLoadOptions,
serverConfigValues?: Map<string, string>
): Promise<WorkspaceData> {
const { filterSets, links, layoutConfig } =
await UserLayoutUtils.getDefaultLayout(
layoutStorage,
options?.isConsoleAvailable
);

return {
settings: {
defaultDateTimeFormat:
DateTimeColumnFormatter.DEFAULT_DATETIME_FORMAT_STRING,
LocalWorkspaceStorage.getServerConfigValueOrUseDefault(
serverConfigValues,
'dateTimeFormat',
DateTimeColumnFormatter.DEFAULT_DATETIME_FORMAT_STRING
),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of setting the value, we should leave it undefined; that way if the server value is updated again, user gets the new value unless they've explicitly updated the option before.

That's how we handle it on Enterprise, anyway: https://github.com/deephaven-ent/iris/blob/b41e56506498118f27fed79ccac41f3dc2af4617/web/client-ui/src/dashboard/WorkspaceStorage.ts#L174
https://github.com/deephaven-ent/iris/blob/b41e56506498118f27fed79ccac41f3dc2af4617/web/client-ui/src/settings/FormattingSectionContent.tsx#L857

From a previous commit I did: https://github.com/deephaven-ent/iris/commit/28a75ae75b27bf97fa1046418af89aa16986e412

formatter: [],
timeZone: DateTimeColumnFormatter.DEFAULT_TIME_ZONE_ID,
timeZone: LocalWorkspaceStorage.getServerConfigValueOrUseDefault(
serverConfigValues,
'timeZone',
DateTimeColumnFormatter.DEFAULT_TIME_ZONE_ID
),
showTimeZone: false,
showTSeparator: true,
disableMoveConfirmation: false,
defaultDecimalFormatOptions: {
defaultFormatString: DecimalColumnFormatter.DEFAULT_FORMAT_STRING,
defaultFormatString:
LocalWorkspaceStorage.getServerConfigValueOrUseDefault(
serverConfigValues,
'decimalFormat',
DecimalColumnFormatter.DEFAULT_FORMAT_STRING
),
},
defaultIntegerFormatOptions: {
defaultFormatString: IntegerColumnFormatter.DEFAULT_FORMAT_STRING,
defaultFormatString:
LocalWorkspaceStorage.getServerConfigValueOrUseDefault(
serverConfigValues,
'integerFormat',
IntegerColumnFormatter.DEFAULT_FORMAT_STRING
),
},
truncateNumbersWithPound: false,
truncateNumbersWithPound:
serverConfigValues?.get('truncateNumbersWithPound') === 'true' ??
false,
defaultNotebookSettings: {
isMinimapEnabled: false,
isMinimapEnabled:
serverConfigValues?.get('isMinimapEnabled') === 'true' ?? false,
},
},
layoutConfig,
Expand All @@ -60,12 +92,14 @@ export class LocalWorkspaceStorage implements WorkspaceStorage {

static async makeDefaultWorkspace(
layoutStorage: LayoutStorage,
options?: WorkspaceStorageLoadOptions
options?: WorkspaceStorageLoadOptions,
serverConfigValues?: Map<string, string>
): Promise<Workspace> {
return {
data: await LocalWorkspaceStorage.makeDefaultWorkspaceData(
layoutStorage,
options
options,
serverConfigValues
),
};
}
Expand All @@ -77,7 +111,10 @@ export class LocalWorkspaceStorage implements WorkspaceStorage {
}

// eslint-disable-next-line class-methods-use-this
async load(options?: WorkspaceStorageLoadOptions): Promise<Workspace> {
async load(
options?: WorkspaceStorageLoadOptions,
serverConfigValues?: Map<string, string>
): Promise<Workspace> {
try {
return JSON.parse(
localStorage.getItem(LocalWorkspaceStorage.STORAGE_KEY) ?? ''
Expand All @@ -86,7 +123,8 @@ export class LocalWorkspaceStorage implements WorkspaceStorage {
log.info('Unable to load workspace data, initializing to default data');
return LocalWorkspaceStorage.makeDefaultWorkspace(
this.layoutStorage,
options
options,
serverConfigValues
);
}
}
Expand Down