feat: import config #55

cimigree · 2024-12-11T22:15:24Z

Related to Onboarding Screens

Adds the ability when creating a project to import a config file.
Adds a hook to do so.
The easiest and most straightforward way to do this was through using html
Added a test to test the hook
Took out the extra function in DeviceNaming file
Took out the test for device naming because that test is now related to the new onboardingLogic file

…ice name exists.

… screen. Makes create project screen.

…sue.

… skip steps or go back.

… logic out of naming screens. Fixes the onboarding top menu.

achou11

Think this PR is blocked on some changes we need to make at the Electron level - I'm going to spend a small amount of time putting up a separate PR to help this!

src/renderer/src/hooks/useConfigFileImporter.ts

src/renderer/src/hooks/mutations/projects.ts

…Adjusts some naming in create project screen. Adjusts test accordingly. Removes extra invalidation.

achou11

couple of minor code suggestions and then also some UX-related feedback

src/renderer/src/routes/Onboarding/CreateProjectScreen.tsx

src/renderer/src/hooks/useConfigFileImporter.test.tsx

src/renderer/src/routes/Onboarding/CreateProjectScreen.tsx

…only instead of full path.

achou11 · 2025-01-08T16:12:10Z

src/renderer/src/hooks/useConfigFileImporter.test.tsx

+
+import { useSelectProjectConfigFile } from './mutations/file-system'
+
+describe('useSelectProjectConfigFile', () => {


non-blocking but would be good to add a test here for when the payload from window.runtime.selectFile() is invalid e.g. the path or name are not strings

Just FYI, to get it to "throw" the error, I have to mock the selectFile as a rejected promise... because otherwise I would actually have to spin up Electron or the preload script with an integration test or an E2E test. Hope that is ok. Is this useful? Not sure...

I have to mock the selectFile as a rejected promise

yeah this is what I figured you would do for now. think that's fine 👍

EDIT: re-reading it and yeah, my initial suggestion was something that can't be done easily (i.e. stub the ipc call to electron). there's probably a way to do it but not worth figuring it out. Given that, maybe not as useful as I initially thought

src/renderer/src/hooks/useConfigFileImporter.test.tsx

cimigree added 17 commits December 3, 2024 17:49

Sets up basics for device naming screen. Still needs api call to work.

9d4662b

Removes console logs.

1ebb36c

Adds the next screen create join project screen to check that the dev…

0ed4682

…ice name exists.

Adds segmenter count and byte count to limit device name length.

45e02b5

Makes reusable onboarding layout component. Makes create join project…

5441dda

… screen. Makes create project screen.

Merges with main for device naming grapheme count logic.

b3747c2

Updates grapheme count methods

8b2414b

Moves files into various folders and updates imports. Fixes height is…

527f4c8

…sue.

Adjustments to device naming screen.

087c785

Fixes height of screens. Finishes basic UI for create a project screen.

5465d5f

Allows button to take className prop. Sets up top menu so user cannot…

2e0ffca

… skip steps or go back.

Adds join project screen.

856bf01

Adds bigger icons

35e5687

Fixes styling and responsiveness of first screen.

ce4e810

Makes the layout and menu component just styles and less logic. Moves…

586d2d3

… logic out of naming screens. Fixes the onboarding top menu.

CHanges spacing to 12 and 20 to reflect design decision.

e99e409

Adds ability to import a config file while creating a project.

3434ed7

cimigree requested a review from ErikSin December 11, 2024 22:15

cimigree added 7 commits December 12, 2024 15:28

Merges with main.

f3d6c8b

Some tweaks to file after merge conflicts.

ca1c0fc

Adds a test for the config file importer test.

5ea8957

Adds a test for the config file importer test.

f52ab4b

Merge branch 'main' into feat/import-config

29a1e64

Merges with main.

5a0c1bd

Merges with main.

1d4d7da

cimigree requested review from achou11 and removed request for ErikSin January 6, 2025 16:01

achou11 requested changes Jan 6, 2025

View reviewed changes

src/renderer/src/hooks/useConfigFileImporter.ts Outdated Show resolved Hide resolved

src/renderer/src/hooks/useConfigFileImporter.ts Outdated Show resolved Hide resolved

src/renderer/src/hooks/mutations/projects.ts Outdated Show resolved Hide resolved

achou11 mentioned this pull request Jan 6, 2025

implement ipc for file selection #79

Merged

Merge branch 'main' into feat/import-config

ab532c5

cimigree added 2 commits January 6, 2025 16:04

Replaces html file input with hook that uses electron import dialog. …

9de7aac

…Adjusts some naming in create project screen. Adjusts test accordingly. Removes extra invalidation.

Fixes import. Fixes test.

f105668

cimigree requested a review from achou11 January 6, 2025 21:25

achou11 requested changes Jan 6, 2025

View reviewed changes

cimigree added 3 commits January 7, 2025 13:37

Merge branch 'main' into feat/import-config

d0ce621

Fixes project creation error message. Fixes test. Displays file name …

36101ed

…only instead of full path.

Removes unnecessary prop from test.

00a3a47

cimigree requested a review from achou11 January 7, 2025 19:55

achou11 mentioned this pull request Jan 7, 2025

feat: update runtime.selectFile() to also return the file name #81

Merged

cimigree added 2 commits January 7, 2025 17:06

Merge branch 'main' into feat/import-config

1d2958b

Updates config importer to use new select file. Updates test.

768cff9

achou11 approved these changes Jan 8, 2025

View reviewed changes

Updates test to include throwing an error.

924c8f7

cimigree merged commit 6a9ffae into main Jan 8, 2025
4 checks passed

cimigree deleted the feat/import-config branch January 8, 2025 18:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: import config #55

feat: import config #55

cimigree commented Dec 11, 2024 •

edited

Loading

achou11 left a comment

achou11 left a comment

achou11 Jan 8, 2025

cimigree Jan 8, 2025

achou11 Jan 8, 2025 •

edited

Loading


		import { useSelectProjectConfigFile } from './mutations/file-system'

		describe('useSelectProjectConfigFile', () => {

feat: import config #55

feat: import config #55

Conversation

cimigree commented Dec 11, 2024 • edited Loading

achou11 left a comment

Choose a reason for hiding this comment

achou11 left a comment

Choose a reason for hiding this comment

achou11 Jan 8, 2025

Choose a reason for hiding this comment

cimigree Jan 8, 2025

Choose a reason for hiding this comment

achou11 Jan 8, 2025 • edited Loading

Choose a reason for hiding this comment

cimigree commented Dec 11, 2024 •

edited

Loading

achou11 Jan 8, 2025 •

edited

Loading