Improve spreadsheet import flow #839

alex-Arc · 2024-03-20T19:24:04Z

coderabbitai · 2024-03-20T19:24:09Z

Important

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (33)

apps/client/src/common/api/db.ts is excluded by: none and included by: none
apps/client/src/common/api/excel.ts is excluded by: none and included by: none
apps/client/src/common/api/sheets.ts is excluded by: none and included by: none
apps/client/src/common/utils/uploadUtils.ts is excluded by: none and included by: none
apps/client/src/features/app-settings/panel/sources-panel/GSheetSetup.tsx is excluded by: none and included by: none
apps/client/src/features/app-settings/panel/sources-panel/ImportReview.tsx is excluded by: none and included by: none
apps/client/src/features/app-settings/panel/sources-panel/SourcesPanel.tsx is excluded by: none and included by: none
apps/client/src/features/app-settings/panel/sources-panel/import-map/ImportMapForm.tsx is excluded by: none and included by: none
apps/client/src/features/app-settings/panel/sources-panel/useGoogleSheet.ts is excluded by: none and included by: none
apps/client/src/features/app-settings/panel/sources-panel/useSheetStore.ts is excluded by: none and included by: none
apps/server/src/api-data/db/db.controller.ts is excluded by: none and included by: none
apps/server/src/api-data/db/db.middleware.ts is excluded by: none and included by: none
apps/server/src/api-data/db/db.router.ts is excluded by: none and included by: none
apps/server/src/api-data/excel/excel.controller.ts is excluded by: none and included by: none
apps/server/src/api-data/excel/excel.middleware.ts is excluded by: none and included by: none
apps/server/src/api-data/excel/excel.router.ts is excluded by: none and included by: none
apps/server/src/api-data/excel/excel.service.ts is excluded by: none and included by: none
apps/server/src/api-data/excel/excel.validation.ts is excluded by: none and included by: none
apps/server/src/api-data/index.ts is excluded by: none and included by: none
apps/server/src/api-data/sheets/sheets.controller.ts is excluded by: none and included by: none
apps/server/src/api-data/sheets/sheets.router.ts is excluded by: none and included by: none
apps/server/src/api-data/sheets/sheets.validation.ts is excluded by: none and included by: none
apps/server/src/services/sheet-service/SheetService.ts is excluded by: none and included by: none
apps/server/src/services/sheet-service/__tests__/sheetUtils.test.ts is excluded by: none and included by: none
apps/server/src/services/sheet-service/sheetUtils.ts is excluded by: none and included by: none
apps/server/src/utils/__tests__/parser.test.ts is excluded by: none and included by: none
apps/server/src/utils/__tests__/time.test.ts is excluded by: none and included by: none
apps/server/src/utils/parser.ts is excluded by: none and included by: none
apps/server/src/utils/time.ts is excluded by: none and included by: none
e2e/tests/features/207-spreadsheet-import.spec.ts is excluded by: none and included by: none
e2e/tests/fixtures/test-sheet.xlsx is excluded by: none and included by: none
packages/utils/src/date-utils/isTimeString.test.ts is excluded by: none and included by: none
packages/utils/src/date-utils/isTimeString.ts is excluded by: none and included by: none

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit-tests for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit tests for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

cpvalente

remember to run fix the linter issues.
I am not sure about the structure here, I will take some time to look into it once we can merge

apps/client/src/common/api/db.ts

cpvalente

there is a lot of code here
I made a few suggestions for cleanup, lets start with those and I will look into the details more carefully after

packages/utils/src/date-utils/isTimeString.ts

e2e/tests/features/207-spreadsheet-import.spec.ts

apps/server/src/utils/time.ts

apps/server/src/utils/parser.ts

apps/server/src/api-data/sheets/sheets.controller.ts

apps/server/src/api-data/excel/excel.controller.ts

cpvalente

🚀

# Conflicts: # apps/server/src/api-data/db/db.controller.ts

alex-Arc · 2024-03-22T17:52:05Z

if you have a chance to skim it that would be great
especially the new service file https://github.com/cpvalente/ontime/blob/improve-spreadsheet-import-flow/apps/server/src/api-data/excel/excel.service.ts

cpvalente · 2024-03-22T18:08:21Z

apps/server/src/utils/__tests__/parser.test.ts

@@ -874,8 +874,8 @@ describe('parseExcel()', () => {
    // TODO: update tests once import is resolved


You can remove this todo now

cpvalente · 2024-03-22T18:09:09Z

apps/server/src/utils/parser.ts

@@ -192,10 +189,6 @@ export const parseExcel = (excelData: unknown[][], options?: Partial<ImportMap>)
        }
      } else if (j === titleIndex) {
        event.title = makeString(column, '');
-        // if this is a block, we have nothing else to import
-        if (event.type === SupportedEvent.Block) {


Question, can you give some background to the decision to remove this?

yeah

it tried testing out what this skips, and calling continue in an exhaustive else if stack doesn't change anything
and as the type might not be the first thing found all the timer event fields will be added to a block event

so i added the clean up after https://github.com/cpvalente/ontime/pull/839/files/9b459c1fe43fe7359291a83f0f15907d06330d82#r1536170551

cpvalente · 2024-03-22T18:10:21Z

apps/server/src/utils/time.ts

@@ -35,22 +35,40 @@ const parse = (valueAsString: string): number => {
  return Math.abs(parsed);
 };

+const stripAMPM = (value: string) => {


I think we have a function isAMPM that does some of this?

alex-Arc · 2024-03-22T20:26:05Z

apps/server/src/utils/parser.ts

-        event.timerType = TimerType.CountDown;
-        event.type = SupportedEvent.Event;
+      // if it is a Block type drop all other filed
+      if (event.type === SupportedEvent.Block) {


cleans up the block event

alex-Arc added 4 commits March 20, 2024 18:54

feat: add dropdown to worksheet selection

3d88b61

feat: add dropdown to worksheet selection to g sheets also

23a91e7

feat: move revoke to separate button

9027d2d

fix: only show revoke in gsheet flow

21aaee9

lint

aad6c62

cpvalente reviewed Mar 20, 2024

View reviewed changes

apps/client/src/common/api/db.ts Outdated Show resolved Hide resolved

alex-Arc added 4 commits March 21, 2024 00:10

refactor: extract excel flow to separate controller

afd076a

refactor: remove unused imports

0c52b78

test: excel import flow

e2ee02d

feat: allow AM/PM importing from sheets

f857a0f

cpvalente reviewed Mar 21, 2024

View reviewed changes

Merge branch 'v3' into improve-spreadsheet-import-flow

a91220d

cpvalente approved these changes Mar 22, 2024

View reviewed changes

alex-Arc added 15 commits March 22, 2024 14:46

refactor: test using testID

bfa99f7

chore: comment not correct anymore

7203830

refactor: don't mutate input param

3bd3b15

refactor: cleanup block events on import

e6fc424

refactor: testID sometimes break

4408b9c

refactor: don't send single values as objects

b101703

refactor: extract to excel.service.ts

0ac7eb6

chore: show spinner when uploading sheet and disable the other option

85aea2a

chore: lint

d93d59a

chore: don't show "success" when canceling the import

dea38b1

Merge branch 'v3' into improve-spreadsheet-import-flow

4193e6b

# Conflicts: # apps/server/src/api-data/db/db.controller.ts

chore: cleanup after merge

b0f3193

chore: export boolean types properly to sheets

b616297

chore: fix test for - export boolean types properly to sheets

64fd21a

chore: test for uppper case custom labels during import

9b459c1

alex-Arc requested a review from cpvalente March 22, 2024 17:50

This comment was marked as resolved.

Sign in to view

fix: upper case import

c777076

cpvalente reviewed Mar 22, 2024

View reviewed changes

alex-Arc commented Mar 22, 2024

View reviewed changes

alex-Arc merged commit f5e9a25 into v3 Mar 22, 2024
3 checks passed

alex-Arc deleted the improve-spreadsheet-import-flow branch March 22, 2024 20:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve spreadsheet import flow #839

Improve spreadsheet import flow #839

alex-Arc commented Mar 20, 2024

coderabbitai bot commented Mar 20, 2024 •

edited

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

cpvalente left a comment

cpvalente left a comment

cpvalente left a comment

alex-Arc commented Mar 22, 2024

This comment was marked as resolved.

cpvalente Mar 22, 2024

cpvalente Mar 22, 2024

alex-Arc Mar 22, 2024

cpvalente Mar 22, 2024

alex-Arc Mar 22, 2024

		@@ -874,8 +874,8 @@ describe('parseExcel()', () => {
		// TODO: update tests once import is resolved

Improve spreadsheet import flow #839

Improve spreadsheet import flow #839

Conversation

alex-Arc commented Mar 20, 2024

coderabbitai bot commented Mar 20, 2024 • edited

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

cpvalente left a comment

Choose a reason for hiding this comment

cpvalente left a comment

Choose a reason for hiding this comment

cpvalente left a comment

Choose a reason for hiding this comment

alex-Arc commented Mar 22, 2024

This comment was marked as resolved.

cpvalente Mar 22, 2024

Choose a reason for hiding this comment

cpvalente Mar 22, 2024

Choose a reason for hiding this comment

alex-Arc Mar 22, 2024

Choose a reason for hiding this comment

cpvalente Mar 22, 2024

Choose a reason for hiding this comment

alex-Arc Mar 22, 2024

Choose a reason for hiding this comment

coderabbitai bot commented Mar 20, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)