Skip to content

Commit

Permalink
get and set user settings in global editor properly (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
@bollwyvl
bollwyvl authored Apr 4, 2020
2 parents 9a27e34 + daa17c7 commit 41dc3a6
Show file tree
Hide file tree
Showing 7 changed files with 126 additions and 100 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## v1.0.1

- Fixes issue with global setting

## v1.0.0

- Support JupyterLab 2.0
Expand Down
2 changes: 1 addition & 1 deletion packages/jupyterlab-fonts/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"url": "https://github.com/deathbeds/jupyterlab-fonts.git"
},
"types": "lib/index.d.ts",
"version": "1.0.0",
"version": "1.0.1",
"dependencies": {
"jss-preset-default": "^4.5.0",
"jss": "^9.8.7",
Expand Down
1 change: 1 addition & 0 deletions packages/jupyterlab-fonts/src/editor.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@ export class FontEditor extends VDomRenderer<FontEditorModel> {
const onChange = (evt: React.FormEvent<HTMLSelectElement>) => {
let value: string | null = (evt.target as HTMLSelectElement).value;
value = value === DUMMY ? null : value;
console.log(prop, kind, value);
m.fonts
.setTextStyle(prop, value, {
kind,
Expand Down
18 changes: 10 additions & 8 deletions packages/jupyterlab-fonts/src/manager.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,16 +167,18 @@ export class FontManager implements IFontManager {
if (!notebook && !this.settings) {
return;
}
let oldStyles: SCHEMA.IStyles = {};
let oldStyles: SCHEMA.IStyles;

if (notebook?.model) {
try {
oldStyles = notebook
? (notebook.model.metadata.get(PACKAGE_NAME) as any).styles
: (this._settings.get('styles').composite as any);
} catch (err) {
//
const model = notebook?.model;

try {
if (model) {
oldStyles = (model.metadata.get(PACKAGE_NAME) as any).styles;
} else {
oldStyles = this._settings.get('styles').user as any;
}
} catch (err) {
oldStyles = {};
}

let styles: SCHEMA.IStyles = JSON.parse(JSON.stringify(oldStyles || {}));
Expand Down
179 changes: 89 additions & 90 deletions tests/acceptance/Editor.robot
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,84 +12,58 @@ ${ED} css:.jp-FontsEditor
${TAB} li[contains(@class, 'lm-TabBar-tab')]
${ICON_FONT} *[@data-icon = 'fonts:fonts']
${ICON_LICENSE} *[@data-icon = 'fonts:license']
${ICON_SETTINGS} *[@data-icon = 'ui-components:settings']
${ICON_NOTEBOOK} *[@data-icon = 'ui-components:notebook']
${ICON_CLOSE} div[contains(@class, 'lm-TabBar-tabCloseIcon')]
${BUTTON} .jp-FontsEditor-button
${SETTING_ITEM} //div[contains(@class, 'jp-PluginList')]//li
${SETTINGS_RAW_CM} .jp-SettingsRawEditor-user .CodeMirror

*** Test Cases ***
Global Font Editor
[Documentation] Customize Global fonts with the Font Editor
[Setup] Open the Global Font Editor
[Template] Use the font editor to configure fonts
Global Code Font -
Global Code Font Anonymous Pro Bold
Global Code Font Anonymous Pro Regular
Global Code Font DejaVu Sans Mono
Global Code Font DejaVu Sans Mono Bold
Global Code Font Fira Code Bold
Global Code Font Fira Code Light
Global Code Font Fira Code Medium
Global Code Font Fira Code Regular
Global Code Font -
Global Code Line Height -
Global Code Line Height 2
Global Code Line Height -
Global Code Size -
Global Code Size 20px
Global Code Size -
Global Content Font -
Global Content Font Anonymous Pro Bold
Global Content Font Anonymous Pro Regular
Global Content Font DejaVu Sans Mono
Global Content Font DejaVu Sans Mono Bold
Global Content Font Fira Code Bold
Global Content Font Fira Code Light
Global Content Font Fira Code Medium
Global Content Font Fira Code Regular
Global Content Font -
Global Content Line Height -
Global Content Line Height 2
Global Content Line Height -
Global Content Size -
Global Content Size 20px
Global Content Size -
Global Code Anonymous Pro Bold
Global Code Anonymous Pro Regular
Global Code DejaVu Sans Mono
Global Code DejaVu Sans Mono Bold
Global Code Fira Code Bold
Global Code Fira Code Light
Global Code Fira Code Medium
Global Code Fira Code Regular
Global Content Anonymous Pro Bold
Global Content Anonymous Pro Regular
Global Content DejaVu Sans Mono
Global Content DejaVu Sans Mono Bold
Global Content Fira Code Bold
Global Content Fira Code Light
Global Content Fira Code Medium
Global Content Fira Code Regular
[Teardown] Close the Font Editor

Notebook Font Editor
[Documentation] Customize Notebook fonts with the Font Editor
[Setup] Open the Notebook Font Editor
[Template] Use the font editor to configure fonts
Notebook Code Font -
Notebook Code Font Anonymous Pro Bold
Notebook Code Font Anonymous Pro Regular
Notebook Code Font DejaVu Sans Mono
Notebook Code Font DejaVu Sans Mono Bold
Notebook Code Font Fira Code Bold
Notebook Code Font Fira Code Light
Notebook Code Font Fira Code Medium
Notebook Code Font Fira Code Regular
Notebook Code Font -
Notebook Code Line Height -
Notebook Code Line Height 2
Notebook Code Line Height -
Notebook Code Size -
Notebook Code Size 20px
Notebook Code Size -
Notebook Content Font -
Notebook Content Font Anonymous Pro Bold
Notebook Content Font Anonymous Pro Regular
Notebook Content Font DejaVu Sans Mono
Notebook Content Font DejaVu Sans Mono Bold
Notebook Content Font Fira Code Bold
Notebook Content Font Fira Code Light
Notebook Content Font Fira Code Medium
Notebook Content Font Fira Code Regular
Notebook Content Font -
Notebook Content Line Height -
Notebook Content Line Height 2
Notebook Content Line Height -
Notebook Content Size -
Notebook Content Size 20px
Notebook Content Size -
Notebook Code -
Notebook Code Anonymous Pro Bold
Notebook Code Anonymous Pro Regular
Notebook Code DejaVu Sans Mono
Notebook Code DejaVu Sans Mono Bold
Notebook Code Fira Code Bold
Notebook Code Fira Code Light
Notebook Code Fira Code Medium
Notebook Code Fira Code Regular
Notebook Content -
Notebook Content Anonymous Pro Bold
Notebook Content Anonymous Pro Regular
Notebook Content DejaVu Sans Mono
Notebook Content DejaVu Sans Mono Bold
Notebook Content Fira Code Bold
Notebook Content Fira Code Light
Notebook Content Fira Code Medium
Notebook Content Fira Code Regular
[Teardown] Close the Font Editor

Global Enable/Disable
Expand All @@ -100,34 +74,37 @@ Global Enable/Disable
Use the Global Font Editor to enable custom fonts
[Teardown] Close the Font Editor

License Viewing
[Documentation] Ensure Licenses are available in the Font Editor
[Setup] Open the Notebook Font Editor
[Template] Check font license is visible in Editor
Anonymous Pro Bold
Anonymous Pro Regular
DejaVu Sans Mono
DejaVu Sans Mono Bold
Fira Code Bold
Fira Code Light
Fira Code Medium
Fira Code Regular
[Teardown] Close the Font Editor

*** Keywords ***
Open the Global Font Editor
[Documentation] Use the JupyterLab Menu to open the global font editor
Prepare to test a font editor
[Documentation] Open a notebook and settings
Open JupyterLab
Make a Hello World Python 3 Notebook
Maybe Close Sidebar

Open Advanced Settings to Validate Fonts
[Documentation] use advanced settings to validate changes
Click JupyterLab Menu Settings
Click JupyterLab Menu Item Advanced Settings Editor
${settings} = Set Variable ${DOCK}//${TAB}//${ICON_SETTINGS}/../..
${fonts} = Set Variable ${SETTING_ITEM}//${ICON_FONT}
Wait Until Page Contains Element ${fonts}
Click Element ${fonts}
Drag And Drop By Offset ${settings} 0 700
Click Element css:.jp-Notebook .CodeMirror

Open the Global Font Editor
[Documentation] Use the JupyterLab Menu to open the global font editor
Prepare to test a font editor
Click JupyterLab Menu Settings
Click JupyterLab Menu Item Fonts
Click JupyterLab Menu Item Global Fonts...
Open Advanced Settings to Validate Fonts

Open the Notebook Font Editor
[Documentation] Use the Notebook button bar to open the notebook font editor
Open JupyterLab
Make a Hello World Python 3 Notebook
Prepare to test a font editor
Click Element css:.jp-Toolbar-item [data-icon\='fonts:fonts']
Open Advanced Settings to Validate Fonts

Close the Font Editor
[Documentation] Close the Notebook Font Editor by closing the tab
Expand All @@ -139,22 +116,31 @@ Close the License Viewer
Click Element ${DOCK}//${TAB}//${ICON_LICENSE}/../../${ICON_CLOSE}

Use the font editor to configure fonts
[Arguments] ${scope} ${kind} ${aspect} ${value}
[Arguments] ${scope} ${kind} ${font}
[Documentation] Presently, change a dropdown in the font editor
Set Screenshot Directory ${OUTPUT_DIR}/editor/${scope}/${kind}/${aspect}/${value}
Set Screenshot Directory ${OUTPUT_DIR}/editor/${scope}/${kind}/${font}
Change a Font Dropdown ${scope} ${kind} Font ${font} 0
Run Keyword If "${scope}" == "Global" Check font license is visible in Editor
Change a Font Dropdown ${scope} ${kind} Size - 0
FOR ${size} IN RANGE 12 20 4
Change a Font Dropdown ${scope} ${kind} Size ${size}px ${size}
Run Keyword If "${scope}" == "Global" Settings Should Contain ${font}
END
Change a Font Dropdown ${scope} ${kind} Font - 99

Change a Font Dropdown
[Arguments] ${scope} ${kind} ${aspect} ${value} ${idx}=0
[Documentation] Update a particular typography value
${sel} = Set Variable ${ED} section[title="${kind}"] select[title="${aspect}"]
Capture Page Screenshot 00_before.png
Select From List By Label ${sel} ${value}
Capture Page Screenshot 01_after.png
Capture Page Screenshot ${aspect}_${idx}.png
Run Keyword If "${scope}" == "Global" Settings Should Contain ${value}

Check font license is visible in Editor
[Arguments] ${value}
[Documentation] Verify that the licenses are loaded
Use the font editor to configure fonts Notebook Code Font ${value}
Click Element css:.jp-FontsEditor-field ${BUTTON}
Wait Until Page Contains Element css:.jp-LicenseViewer pre timeout=20s
Set Screenshot Directory ${OUTPUT_DIR}/license/${value}
Capture Page Screenshot 02_license.png
Capture Page Screenshot Font_1_license.png
Close the License Viewer

Use the Global font editor to ${what} custom fonts
Expand All @@ -165,3 +151,16 @@ Use the Global font editor to ${what} custom fonts
Run Keyword If "${what}"=="enable" Select Checkbox ${input}
Run Keyword If "${what}"=="disable" Unselect Checkbox ${input}
Capture Page Screenshot 01_after.png

Settings Should Contain
[Arguments] ${value}
[Documentation] Check the settings for a string
${settings} = Get Editor Content ${SETTINGS_RAW_CM}
Run Keyword If "${value}" != '-' Should Contain ${settings} ${value}

Get Editor Content
[Arguments] ${sel}
[Documentation] Get CodeMirror content
${js} = Set Variable return document.querySelector(`${sel}`).CodeMirror.getValue()
${content} Execute JavaScript ${js}
[Return] ${content}
12 changes: 12 additions & 0 deletions tests/etc/jupyter_notebook_config.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"LabApp": {
"user_settings_dir": ".settings",
"workspaces_dir": ".workspaces",
"tornado_settings": {
"page_config_data": {
"buildCheck": false,
"buildAvailable": false
}
}
}
}
10 changes: 9 additions & 1 deletion tests/resources/Lab.robot
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Library OperatingSystem
*** Variables ***
${CELL_CSS} .jp-Notebook .jp-Cell:last-of-type .jp-InputArea-editor .CodeMirror
${TOKEN} hopelesslyinsecure
${LAB_CMD} jupyter-lab --no-browser --NotebookApp.token=${TOKEN} --port 18888
${LAB_CMD} jupyter-lab --no-browser --debug --NotebookApp.token=${TOKEN} --port 18888
${LAB_URL} http://localhost:18888/lab?token=${TOKEN}&reset
${SPLASH_ID} jupyterlab-splash
${SPINNER} css:.jp-Spinner
Expand All @@ -25,6 +25,7 @@ Prepare for testing fonts
Start Jupyterlab
${browser}= Get Environment Variable BROWSER ${BROWSER}
Open Browser about:blank ${browser}
Set Window Size 1920 1080
Set tags ${browser}

Wait for Splash Screen
Expand All @@ -46,6 +47,7 @@ Start JupyterLab
[Documentation] Start a Jupyter Notebook Server with JupyterLab
${home} = Set Variable ${OUTPUT_DIR}${/}home
Create Directory ${home}
Copy File tests${/}etc${/}jupyter_notebook_config.json ${home}
${log} = Set Variable ${OUTPUT_DIR}${/}lab.log
Start Process ${LAB_CMD} shell=true stderr=STDOUT stdout=${log} cwd=${home}
Sleep 5s
Expand Down Expand Up @@ -92,3 +94,9 @@ Clean Up JupyterLab
Set Screenshot Directory ${OUTPUT_DIR}
Close All Browsers
Terminate All Processes kill=True

Maybe Close Sidebar
[Arguments] ${side}=left
[Documentation] Clean up some real estate
${els} = Get WebElements css:.jp-SideBar.jp-mod-${side.lower()} .lm-mod-current
Run Keyword If ${els.__len__} Click Element ${els[0]}

0 comments on commit 41dc3a6

Please sign in to comment.