Calendar widget #56

JakubSerafin · 2023-08-08T03:43:35Z

calendar widget that allow to show data from the table on the daily/weekly/monthly view.
features:

utilizing grist column mapping feature to bind any columns from table with valid type as a start / end dates, event title and "All Day" flag
switching between calendar perspectives (day/week/month) is persisted using grist widget options
linking is supported (click on the table row will navigate and highlight calendar event, clicking calendar event can be utilized by other widget to set cursor on that data)
drag and drop on the calendar will update data in the table
select time range on the calendar will create new row in the table

TESTS:
a few tests was added for CRUD operations in the table being reflected on the calendar.

…ing)

…C/calendar-widget-poc # Conflicts: # package.json # yarn.lock

…nt reference: stale element not found problem while testing binding columns to widgets

commented code removed

explanation of try-catch in SteCustomWidgetMapping

test/getGrist.ts

paulfitz

(partial review, ran out of time, will work on more later)

.github/workflows/main.yml

calendar/index.html

calendar/package.json

calendar/page.js

paulfitz · 2023-08-11T16:54:26Z

calendar/page.js

+// when user move or resize event on the calendar, we want to update the record in the table
+const onCalendarEventBeingUpdated = async (info) => {
+    if (info.changes?.start || info.changes?.end) {
+      const record =  await grist.fetchSelectedRecord(info.event.id);


Hmm why do we need to refetch the record from the application? Can't we just update the start and end?

It was my first approach, but TableOperations.update() seems to nullify all fields that are absent in argument.

That seems bad, is this a bug in TableOperations.update? Fetching, patching and re-saving would leave any user of this api prone to races.

Ok, it was not a bug in TableOperations.update but rather specific way in with grist.mapColumnNamesBack works. It map back all fields that was in source object, but for absent fields it just put a "undefined" under the target object value for given key.
It's up to discussion if grist.mapColumnNamesBack should work that way

Any thoughts on what grist.mapColumnNamesBack should do for absent fields @berhalak ?

calendar/page.js

test/getGrist.ts

test/calendar.ts

test/getGrist.ts

…erting

…C/calendar-widget-poc # Conflicts: # test/getGrist.ts

paulfitz

Close to being fine. I continue to find erratic whitespace distracting, most of my comments were just that, sorry.

It would probably make sense to write a widget this big in typescript rather than straight javascript, but reasonable not to tackle setting that up in the one piece of work.

calendar/page.js

test/calendar.ts

test/getGrist.ts

paulfitz · 2023-08-17T21:23:20Z

test/getGrist.ts

+      } catch (e) {
+        //sometimes here we get into "detached" state and test fail.
+        //if this happened, just try one more time
+       await  driver.findWait(selector, 2000).click();


Suggested change

await driver.findWait(selector, 2000).click();

await driver.findWait(selector, 2000).click();

Did this change turn out to be good enough for the tests to be reliable?

i did some empirical tests - before in average one in ten tests run was failing on my machine on a set of 50 runs. After this change i get no single failure in 80 runs.

paulfitz

Thanks @JakubSerafin !

JakubSerafin added 30 commits June 21, 2023 16:47

first version

41f6981

updating events from calendar to table

f739e37

mapping columns

86bd58c

changing calendar perspective - day/month/week

9ee8531

typos fixes, allDayEvent support improved

3766351

calendar changes

c215ffa

styling, navigating to the row selected in main widget

c41bc49

scroll

c02a8b2

deleting events, improved styles, creating new event based on selection

d6fdaa5

calendar widget being selectable as linking source.

1a3b9b8

saving edited event is now independent of columns name (based on mapp…

6b2a30c

…ing)

creeating new events can handle any column names now

9ab1af5

first version

ad5065c

updating events from calendar to table

06fa897

mapping columns

ce02e71

changing calendar perspective - day/month/week

8dd89c1

typos fixes, allDayEvent support improved

df8d4f7

calendar changes

4ea9d9a

styling, navigating to the row selected in main widget

06ff8e6

scroll

86a9a70

deleting events, improved styles, creating new event based on selection

b85bedd

calendar widget being selectable as linking source.

5fd4729

saving edited event is now independent of columns name (based on mapp…

84d0b49

…ing)

creeating new events can handle any column names now

a2151b1

Merge remote-tracking branch 'origin/POC/calendar-widget-poc' into PO…

ae46dfc

…C/calendar-widget-poc # Conflicts: # package.json # yarn.lock

unit tests for calendar

dfbe568

tests

bf57d15

calendar refactor

4b62148

refactor - selecting event to mark

f2ebcf5

move part of the code to the class to give it some structure

0d10535

JakubSerafin added 4 commits August 9, 2023 15:22

whole day test fix

d282ac3

test if this would fix on the StaleElementReferenceError: stale eleme…

98f92c1

…nt reference: stale element not found problem while testing binding columns to widgets

Update calendar.ts

5b2708d

commented code removed

Update getGrist.ts

327a72d

explanation of try-catch in SteCustomWidgetMapping

paulfitz self-requested a review August 11, 2023 13:21

paulfitz reviewed Aug 11, 2023

View reviewed changes

test/getGrist.ts Outdated Show resolved Hide resolved

paulfitz reviewed Aug 11, 2023

View reviewed changes

test/getGrist.ts Outdated Show resolved Hide resolved

JakubSerafin added 16 commits August 16, 2023 10:29

awaiting in setCustomWidgetMapping

114ce45

widget name changed from calendar-map to widget-calendar

b711366

widget name changed from calendar-map to widget-calendar

9341245

Calendar name separated to const

6c9a829

read function improved to a more modern version

6906ae8

rewording comment to convertEventToGristTableFormat

476612a

various typos and

2ac80fa

more typos and code quality fixes

453b3a2

unit tests fixes, waiting for the calendar being refreshed before ass…

85e3064

…erting

Merge remote-tracking branch 'origin/POC/calendar-widget-poc' into PO…

850d5c2

…C/calendar-widget-poc # Conflicts: # test/getGrist.ts

revert unnecessary changes

c407635

sendActionsAndWaitForServer goes from string to function

727e2cf

removing unused function

d5ec8de

tests for changing perspective and date

301fb98

filtering data for table.update

5918966

build script fixes, cheking record types when grist selection is updated

d71488b

paulfitz reviewed Aug 17, 2023

View reviewed changes

review fixes

e24c24a

paulfitz approved these changes Aug 18, 2023

View reviewed changes

paulfitz merged commit 03c9b06 into master Aug 21, 2023
1 check passed

paulfitz deleted the POC/calendar-widget-poc branch August 21, 2023 18:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Calendar widget #56

Calendar widget #56

JakubSerafin commented Aug 8, 2023

paulfitz left a comment

paulfitz Aug 11, 2023

JakubSerafin Aug 16, 2023

paulfitz Aug 16, 2023

JakubSerafin Aug 17, 2023

paulfitz Aug 17, 2023

paulfitz left a comment

paulfitz Aug 17, 2023

paulfitz Aug 17, 2023

JakubSerafin Aug 18, 2023

paulfitz left a comment

	await driver.findWait(selector, 2000).click();
	await driver.findWait(selector, 2000).click();

Calendar widget #56

Calendar widget #56

Conversation

JakubSerafin commented Aug 8, 2023

paulfitz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paulfitz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paulfitz left a comment

Choose a reason for hiding this comment