# Okna czasowe - opis działania pamięci podręcznej

## Rodzaje pamięci podręcznej dla okien czasowych

1. Pamięć oparta o ID okna czasowego

   - metoda odpowiedzialna za generowanie:

     ```
     @Cacheable(value = CacheService.TIME_WINDOWS_CACHE, key = {timeWindow.id})
     @Transactional(readOnly = true)
     Map asCachedMapForUniversalAccess(TimeWindow timeWindow) {
         timeWindow.asCommonMap()
     }
     ```
   - podstawowa struktura mapy okna w pamięci podręcznej:

     ```
     /**
      * Zawiera podstawowe informacje o oknie - dostępne dla wszystkich użytkowników.
      *
      * @return
      */
     HashMap asCommonMap() {
         String dateFormat = "EEE MMM d yyyy HH:mm:ss 'GMT'Z"

         return [
                 id        : id,
                 ramp      : rampId,
                 start     : new SimpleDateFormat(dateFormat, Locale.US).format(start),
                 stop      : new SimpleDateFormat(dateFormat, Locale.US).format(stop),
                 deleted   : deleted,
                 isTemplate: isTemplate,
                 note      : note,
                 state     : getStateOfDisabledWindow(false)
         ]
     }
     ```
2. Pamięć oparta o ID okna czasowego oraz ID grupy użytkownika

   > Grupa użytkownika to pole `userGroup` przypisane do obiektu klasy `Person`

   - metoda odpowiedzialna za generowanie:

     ```
     @Cacheable(value = CacheService.TIME_WINDOWS_CACHE, key = [{timeWindow.id}, {userGroup.id }])
     @Transactional(readOnly = true)
     Map asCachedMapForUserGroup(TimeWindow timeWindow, UserGroup userGroup) {
         timeWindow.asMapForUserGroup(userGroup)
     }
     ```
   - podstawowa struktura mapy okna w pamięci podręcznej:

     ```
     /**
      * Zawiera informacje dostępne dla użytkownika o danej grupie.
      *
      * @param userGroup
      * @return
      */
     HashMap asMapForUserGroup(UserGroup userGroup) {

         HashMap map = asCommonMap()

         Long windowCompanyId = canCompanyInfoBeAccessedByUserGroup(userGroup) ? this.company?.id : null
         map.company = windowCompanyId

         Long windowUserGroupId = canUserGroupInfoBeAccessedByUserGroup(userGroup) ? this.userGroup?.id : null
         map.userGroup = windowUserGroupId

         if (transportId && (!userGroup?.company || (userGroup?.company?.canAccess(transport) && transport.canBeAccessedBy(userGroup)))) {
             map.step = stepId
             map.transport = transportId
             map.transportType = transport?.transportTypeId

             map << scheduleSettingService.findSectionsContentForTimeWindow(transport, this)
             map.wasDelayedOnMarkedTask = wasDelayedOnMarkedTask()
             map.color = findColor()
             map.state = WINDOW_STATE_CLASS.transport
         } else {
             Boolean hasCompanyOrUserGroup = windowCompanyId || windowUserGroupId
             map.state = getStateOfDisabledWindow(hasCompanyOrUserGroup)
         }

         return map
     }
     ```

## Generowanie oraz pobieranie z pamięci mapy okna czasowego

Za generowanie odpowiedniej mapy okna czasowego odpowiedzialna jest metoda:

```
    /**
     * Próbuje zwrócić mapę okna zapisaną w pamięci podręcznej lub, jeśli zakończy się to błędem, na nowo wygenerować mapę.
     */
    @Transactional(readOnly = true)
    Map asMap(TimeWindow timeWindow, UserGroup userGroup = null) {
        try {
            if (timeWindow.isBlockade() || !timeWindow.isUserGroupInvolved(userGroup)) {
                grailsApplication.mainContext.warehouseService.asCachedMapForUniversalAccess(timeWindow)
            } else {
                grailsApplication.mainContext.warehouseService.asCachedMapForUserGroup(timeWindow, userGroup)
            }
        } catch (Exception e) {
            e.printStackTrace()

            if (userGroup && timeWindow.isUserGroupInvolved(userGroup)) {
                return timeWindow.asMapForUserGroup(userGroup)
            } else {
                return timeWindow.asCommonMap()
            }
        }
    }
```

> Definicja metody `isUserGroupInvolved(userGroup)`:

```
    /**
     * Określa, czy podana grupa jest zaangażowana w okno czasowe.
     *
     * <ul>
     *   <li> Dostęp do okna mają na pewno wszystkie grupy pryncypała
     *   <li> Jeżeli jest to okno z transportem, zaangażowani są wszyscy wykonawcy {@link TimeWindow#getExecutorCompanies()}
     *   <li> Jeżeli jest to okno dedykowane firmie {@link TimeWindow#company}, zaangażowane są wszystkie grupy tej firmy
     *   <li> Jeżeli jest to okno dedykowane grupie {@link TimeWindow#userGroup}, zaangażowana jest ta grupa oraz
     *   pozostałe grupy jej firmy, które mają prawo dostępu do transportów pozostałych grup
     *
     * @param userGroup
     * @return
     */
    Boolean isUserGroupInvolved(UserGroup userGroup) {

        if (!userGroup || isBlockade()) {
            return false
        }

        if (this.companyId && this.companyId == userGroup.companyId) {
            // Okno jest oknem dedykowanym firmie -> grupa jest więc zaangażowana.
            return true
        }
        if (this.userGroupId && canUserGroupInfoBeAccessedByUserGroup(userGroup)) {
            // Okno jest oknem dedykowanym grupie -> grupa jest więc zaangażowana.
            return true
        }
        if (this.transportId && userGroup.company?.canAccess(this.transport)) {
            // Okno jest związane z transportem $transport i grupa ma do niego dostęp -> grupa jest więc zaangażowana.
            return true
        }

        // Grupa należy do pryncypała -> ma dostęp do okna. W przeciwnym razie grupa nie jest
        // zaangażowana w okno -> będzie je widziała jako blokadę.
        return userGroup.company.isCurrentPrincipal()
    }
```

### Miejsca oraz akcje wywołujące pobranie mapy okna czasowego w aplikacji

> Informacje wstępne: - tablica `timeWindowIds` przychodzi po wykonaniu zapytania do `TimeWindowRESTController` do metody `updates(Long warehouseId)`, która zbiera listę okien czasowych o czasie w polu `lastUpdated` większym od ostatniego zapytania tej metody (`updates(Long warehouseId)`).  
> \- grupa użytkownika brana jest z pola `userGroup` w klasie `Person`.  
> \- `dostępne dodatkowe zasoby` tyczy się m.in. otrzymanego `json` oraz informacji z `SpringSecurity`

1. Pobranie mapy pojedynczego okna

   - klasa: `TimeWindowRESTController`
   - metoda: `show(TimeWindow)`
   - dostępne dodatkowe zasoby:

     - `id okna czasowego`
     - `aktualnie zalogowany użytkownik`

   Akcje powodujące pobranie mapy:  
   \- automatyczne odświeżanie Harmonogramu - zapytanie o dane okien, które przyszły w tablicy `timeWindowIds`:

   ![](<https://docs.logintegra.com/apollo-backend/static/Schedule &amp; Time windows/others/caches/updateResponsePreview.png>)

   - ręczne odświeżenie Harmonogramu (za pomocą klawisza `Odśwież` w Harmonogramie)

     - zapytanie o dane okien, które przyszły w tablicy `timeWindowIds`
   - zapisanie okna czasowego

     - po zapisaniu okna czasowego wywoływane jest automatycznie zapytanie o `updates(Long warehouseId)`, które zwraca co najmniej `id` zapisanego okna i powoduje pobranie jego mapy
     - dodatkowo po kolejnym odświeżaniu wychodzi zapytanie o dane okien, które przyszły w tablicy `timeWindowIds` - w tym przypadku w tablicy będzie co najmniej `id` zapisanego okna
   - usunięcie okna czasowego

     - po kolejnym odświeżaniu po usunięciu wychodzi zapytanie o dane okien, które przyszły w tablicy `timeWindowIds` - w tym przypadku w tablicy będzie co najmniej `id` usuniętego okna
   - edycja okna czasowego

     - po kolejnym odświeżaniu po edycji wychodzi zapytanie o dane okien, które przyszły w tablicy `timeWindowIds` - w tym przypadku w tablicy będzie co najmniej `id` edytowanego okna
   - zamiana miejscami okien czasowych

     - po kolejnym odświeżaniu po zamianie wychodzi zapytanie o dane okien, które przyszły w tablicy `timeWindowIds` - w tym przypadku w tablicy będą co najmniej `id` zmienianych okien
2. Pobranie listy okien czasowych

   - klasa: `TimeWindowRESTController`
   - metoda: `index(Integer)`
   - dostępne dodatkowe zasoby:
   - `mapa z danymi: [start, stop, rampsIds, warehouseId, isTemplate]`
   - `aktualnie zalogowany użytkownik`
   - `aktualny pryncypał`

   Akcje powodujące pobranie mapy:  
   \- wyświetlenie Harmonogramu - zapytanie o listę okien z danego magazynu, danego przedziału wyświetlania (jeśli odwiedzamy Harmonogram pierwszy raz po zalogowaniu lub odświeżyliśmy stronę przeglądarki)

   ![](<https://docs.logintegra.com/apollo-backend/static/Schedule &amp; Time windows/others/caches/index.png>)
3. Zapisanie okna czasowego

   - klasa: `TimeWindowRESTController`
   - metoda: `save()`
   - dostępne dodatkowe zasoby:

     - `mapa z danymi okna`
     - `aktualnie zalogowany użytkownik`

   Akcje powodujące pobranie mapy:  
   \- zapisanie okna czasowego
4. Usunięcie okna czasowego

   - klasa: `TimeWindowRESTController`
   - metoda: `delete(TimeWindow)`
   - dostępne dodatkowe zasoby:

     - `id okna czasowego`
     - `aktualnie zalogowany użytkownik`

   Akcje powodujące pobranie mapy:  
   \- usunięcie okna czasowego
5. Edycja okna czasowego

   - klasa: `TimeWindowRESTController`
   - metoda: `update(timeWindowId)`
   - dostępne dodatkowe zasoby:

     - `aktualnie zalogowany użytkownik`

   Akcje powodujące pobranie mapy:  
   \- edycja okna czasowego - zamiana miejscami okien czasowych  
   \- metoda `update(timeWindowId)` wywoływana jest dla obu okien
6. Generowanie pamięci podręcznej w panelu administratora

   Powoduje wygenerowanie zarówno mapy `asMapForUserGroup(userGroup)` jak i mapy `asCommonMap()` dla okien z wybranego zakresu.

   ![](<https://docs.logintegra.com/apollo-backend/static/Schedule &amp; Time windows/others/caches/generateCache.png>)

### Miejsca oraz akcje wywołujące wyczyszczenie mapy okna czasowego w aplikacji

> Wszystkie podane przypadki czyszczą pamięć podręczną okna `asCommonMap` oraz `asMapForUserGroup` biorąc grupy z metody `involvedUserGroups` klasy `TimeWindow` wywoływanej na oknie czasowym.

1. Panel Administratora

   - czyszczenie dla pojedynczego okna

   ![](<https://docs.logintegra.com/apollo-backend/static/Schedule &amp; Time windows/others/caches/clearCacheForTimeWindow.png>)

   - czyszczenie dla wszystkich okien

   ![](<https://docs.logintegra.com/apollo-backend/static/Schedule &amp; Time windows/others/caches/clearTimeWindowsCache.png>)

   - czyszczenie dla transportu - jeśli transport posiada okna czasowe

   ![](<https://docs.logintegra.com/apollo-backend/static/Schedule &amp; Time windows/others/caches/clearTimeWindowsCache.png>)

   - przeniesienie zlecenia do archiwum

   ![](<https://docs.logintegra.com/apollo-backend/static/Schedule &amp; Time windows/others/caches/moveToArchive.png>)

   - anulowanie/Edycja transakcji

   ![](<https://docs.logintegra.com/apollo-backend/static/Schedule &amp; Time windows/others/caches/cancelTransaction.png>)

   - sprawdzanie stanu transportu

   ![](<https://docs.logintegra.com/apollo-backend/static/Schedule &amp; Time windows/others/caches/handleTransportState.png>)
2. Zmiana pola `visibleOnTimeWindow` w klasie `CustomFieldDefinition`

   ![](<https://docs.logintegra.com/apollo-backend/static/Schedule &amp; Time windows/others/caches/clearCacheForTimeWindowCustomField.png>)  
   \- czyszczenie dla okien typu transportu, który posiada dane pole niestandardowe z zakresu czasu:  
   \- od - aktualny czas minus interwał podany w `Parameter.TIME_WINDOW_CLEAR_CACHE_INTERVAL_AFTER_SAVE_CUSTOM_FIELDS`  
   \- do - aktualny czas
3. Zapisanie transportu - jeśli transport od razu posiada okno/okna czasowe
4. Edycja transportu - jeśli transport posiada okno/okna czasowe
5. Usuwanie transportu - jeśli transport posiada okno/okna czasowe
6. Przesunięcie okna czasowego - czyszczenie w dwóch miejscach

   - metoda `moveWindow` w `WarehouseService`
   - metoda `update` w `TimeWindowRESTController`
7. Zamiana miejscami okien czasowych - czyszczenie dla obu okien
8. Edycja awizacji przez SMS
9. Automatyczne usuwanie okien dedykowanych

   > `Od punktu 10. wymienione akcje powodują wyczyszczenie pamięci dla transportu oraz jeśli transport posiada okna czasowe to wyczyszczenie pamięci okien`
10. Zakończenie aukcji dla transportu
11. Edycja indeksu w transporcie
12. Zapisanie transakcji do transportu
13. Odrzucenie/Przyjęcie transakcji przez przewoźnika
14. Zapisanie faktury do zlecenia
15. Ważenie w transporcie
16. Synchronizacja wagi w transporcie
17. Edycja kierowcy (w zasobach firmy)
18. Edycja ciągnika (w zasobach firmy)
