Calendar Rewrite Plan

[ncovercash]

This is for both ui-calendar and mod-calendar; there is no built-in way to replicate this issue on both so it's going here.

These will probably be broken down into sub-issues so their progress can be tracked more easily and put onto the kanban

Requiring Investigation

• Determine preferred testing frameworks
  • FOLIO has gone through many testing frameworks over the years (biggest, cypress, jest, karma, nightmare, etc) and I would like to ensure we write tests with the preferred one
  • Various places of documentation all say each of these is the current preferred one, and I'm not sure which is the most recent/correct.
  • FE testing should be done with rtl and jest. (Investigate Preferred Testing for new Frontend Modules #5)
  • BE testing TBD; dependent upon Spring/RMB and other factors TBD first (Determine Preferred Testing Framework mod-calendar#3)
• Perform Analysis of API Usage Across FOLIO mod-calendar#4
• Analyze and Plan Permission Scopes mod-calendar#5
• Determine the Extent of Audit Logging Required/Desired mod-calendar#6
• Investigate API Route Versioning in the Spring Way mod-calendar#7
• Determine what APIs are available for service point validation mod-calendar#19 (none is currently performed; as long as it looks like a UUID, legacy mod-calendar will accept it)
• Backend Error Message Localization (Investigation) mod-calendar#22

Determining Specifications

• Create database schema (Construct New Database Schema mod-calendar#1)
• Determine new API schema (subject to modification) (blocked by Perform Analysis of API Usage Across FOLIO mod-calendar#4)

New Backend

• Lay foundation for new backend (Lay foundation for new backend mod-calendar#2)
  • Create distinct Hello World Spring example mod-calendar#9
• Master API Implementation Issue mod-calendar#14
  • Map out API schema typings for BC mod-calendar#11
  • POST /calendar/periods/{servicePointId}/period mod-calendar#16
  • POST /calendar/periods/{servicePointId}/period for exceptions mod-calendar#24
  • GET /calendar/periods/{servicePointId}/period mod-calendar#17
  • GET /calendar/periods/{servicePointId}/period/{periodId} mod-calendar#25
  • DELETE /calendar/periods/{servicePointId}/period/{periodId} mod-calendar#26
  • PUT /calendar/periods/{servicePointId}/period/{periodId} mod-calendar#27
  • GET /calendar/periods mod-calendar#28
  • GET /calendar/periods/{servicePointId}/calculateopening mod-calendar#29

Backend Migration

• Backend Database Migration mod-calendar#33
  • SQL to construct new schema
  • Java to parse old data and transform it into the new style
  • SQL to remove old schema
  • FOLSPRINGB-41: Add TenantService event methods for module overriding folio-org/folio-spring-support#39
  • Add reference and sample data mod-calendar#37

Backend Tests

• Ensure each API route works properly
• Ensure that data conversion works correctly
• Fully document all new APIs and schema model

Other

• Backend Error Message Localization mod-calendar#41

UI Rewrite

Admin Work

• Create updated mockups based on meeting discussions and improved UX ideas (slideshow)
  • Separated service point and calendar listings separate on the first pane
  • Get approval (by SIGs/Cheryl?) before major development
• Update user stories
• Add typescript support for UI compilation #16
• Potential additional feature ideas (talk to Steven):
  • Preview calendar

New Backend Infastructure

• Plan new API routes mod-calendar#18
• New API Routes OpenAPI Specification mod-calendar#49
• New API Routes Okapi Descriptors mod-calendar#50
• POST /opening-hours/calendars mod-calendar#54
• GET /opening-hours/calendars/{calendarId*} mod-calendar#56
• GET /opening-hours/calendars mod-calendar#53
• PUT /opening-hours/calendars/{calendarId} mod-calendar#55
• DELETE /opening-hours/calendars/{calendarId*} mod-calendar#57
• GET /opening-hours/dates/{servicePointId}/surrounding-openings/{date} mod-calendar#58
• GET /opening-hours/dates/{servicePointId}/all-openings mod-calendar#59
• Remove legacy endpoints mod-calendar#60
• Update mod-circulation to work with these new and improved endpoints

UI Features/Stories

• As a user, I would like to easily view all currently assigned calendars and the current opening hours for each service point, with sorting of each column.
• As a user, I would like to be able to create new calendars and apply them to multiple service points.
• As a user, I would like to be able to create new calendars with opening hours that can span multiple days
• As a user, I would like to be able to edit existing calendars
• As a user, I would like to be able to add exceptions to calendars to override their openings for some certain day(s).
• As a user, I would like to be able to add exceptions to calendars to close them when they would normally be open.
• As a user, I would like to be able to view all of the information for an existing calendar, including hours, exceptions, and assignments.
• As a user, I would like to be able to preview a monthly calendar of openings for a service point.
• As a user, I would like to be able to delete existing calendars.
• As a user, I would like to be able to duplicate an existing calendar to make a new one without manually copying the information over.
• As a user, I would like to be able to view all calendars, not just those that are currently in effect, with sorting in each column.
• As a user, I would like to be able to purge old calendars with a selectable date (3 months, 6 months, 1 year, 2 years, etc).
• As a user, I would like to be able to purge calendars that are not assigned to any service points.
• As a user, I would like to be able to create calendars that are 24/7 (never close).
• As a user, I would like to be able to sort headings on MCL tables
• As an administrator, I would like to be able to add and control permissions for viewing, editing, and deleting opening hour information.
• As a user, I would like the preference of weekdays starting on anything but Sunday to be properly respected.
• As a user, I would like to view the interface in any language of my choice.

UI Testing

• Jest/RTL unit tests
• Cypress?

Documentation

• Add tutorials to https://docs.folio.com/ for:
  • Explaining new calendar/service point model
  • Creating a simple calendar
  • Creating complex calendars
  • Creating overnight, 24/5, and 24/7 calendars
  • Applying a calendar to service points
  • Adding exceptions
  • Editing/deleting calendars
  • Viewing previous/historic calendars
  • Importance of purging calendars

[ncovercash]

Information from today's meeting with Cheryl: https://github.com/ualibweb/ui-calendar/wiki/2021-10-21-Meeting-with-Cheryl

[ualib-deploy]

Boy, that translation of JSON to sql DB seems like it will be really difficult. We need to find out how standardized the JSON is (schema anywhere to look at?), and then find some code to take the component parts of the JSON file, and shove them in to the appropriate corresponding SQL DB fields / table cells. Right?

[ualib-deploy]

And then we will need to provide the same API output that is expected from any call. I am hoping that this will be relatively easy.

[ncovercash]

It certainly does. I have not investigated that part too in-depth, however, there may be some special API endpoints we can hook to ensure this works properly.

[sjturner-ua]

Should we update these items?

[ncovercash]

They're pretty up to date: currently working on the UI testing category