aboutsummaryrefslogtreecommitdiffstats
path: root/packages/main/src/stores/SharedStore.ts
blob: 9ec796307e38716cad7c8acd550972d8f34eda0f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/*
 * Copyright (C)  2021-2022 Kristóf Marussy <kristof@marussy.com>
 *
 * This file is part of Sophie.
 *
 * Sophie is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 * SPDX-License-Identifier: AGPL-3.0-only
 */

import { sharedStore as originalSharedStore } from '@sophie/shared';
import {
  applySnapshot,
  getSnapshot,
  IMSTArray,
  IMSTMap,
  Instance,
  IReferenceType,
  IStateTreeNode,
  IType,
  resolveIdentifier,
  types,
} from 'mobx-state-tree';

import { getLogger } from '../utils/log';
import overrideProps from '../utils/overrideProps';

import { globalSettings, GlobalSettingsSnapshotIn } from './GlobalSettings';
import { addMissingProfileIds, profile, ProfileConfig } from './Profile';
import {
  addMissingServiceIdsAndProfiles,
  service,
  ServiceConfig,
} from './Service';

const log = getLogger('sharedStore');

export interface Config extends GlobalSettingsSnapshotIn {
  profiles?: ProfileConfig[] | undefined;

  services?: ServiceConfig[] | undefined;
}

function getConfigs<T>(models: { config: T }[]): T[] | undefined {
  return models.length === 0 ? undefined : models.map((model) => model.config);
}

type TypeWithSettings<C> = IType<
  { id: string; settings: C },
  unknown,
  { settings: IStateTreeNode<IType<C, unknown, unknown>> }
>;

function deleteStaleModels<C, D extends TypeWithSettings<C>>(
  currentById: IMSTMap<D>,
  toApplyById: Map<string, C>,
): void {
  const toDelete = new Set(currentById.keys());
  toApplyById.forEach((_settings, id) => toDelete.delete(id));
  toDelete.forEach((id) => currentById.delete(id));
}

function applySettings<C, D extends TypeWithSettings<C>>(
  currentById: IMSTMap<D>,
  toApplyById: Map<string, C>,
): void {
  toApplyById.forEach((settingsSnapshot, id) => {
    const model = currentById.get(id);
    if (model === undefined) {
      currentById.set(id, {
        id,
        settings: settingsSnapshot,
      });
    } else {
      applySnapshot(model.settings, settingsSnapshot);
    }
  });
}

function pushReferences<C, D extends TypeWithSettings<C>>(
  list: IMSTArray<IReferenceType<D>>,
  toApply: [string, C][],
): void {
  list.push(...toApply.map(([id]) => id));
}

export const sharedStore = overrideProps(originalSharedStore, {
  settings: types.optional(globalSettings, {}),
  profilesById: types.map(profile),
  profiles: types.array(types.reference(profile)),
  servicesById: types.map(service),
  services: types.array(types.reference(service)),
  selectedService: types.safeReference(service),
})
  .views((self) => ({
    get config(): Config {
      const { settings, profiles, services } = self;
      const globalSettingsConfig = getSnapshot(settings);
      return {
        ...globalSettingsConfig,
        profiles: getConfigs(profiles),
        services: getConfigs(services),
      };
    },
  }))
  .actions((self) => ({
    loadConfig(config: Config): void {
      // `onPatch` will send store changes piecemeal without any attention to
      // transaction boundaries. We must make sure that any state communicated to the
      // renderer process is actually valid.
      const {
        profiles,
        profilesById,
        selectedService,
        services,
        servicesById,
        settings,
      } = self;
      const { id: selectedServiceId } = selectedService ?? { id: undefined };
      const {
        profiles: profilesConfig,
        services: servicesConfig,
        ...settingsToApply
      } = config;
      const profilesToApply = addMissingProfileIds(profilesConfig);
      const servicesToApply = addMissingServiceIdsAndProfiles(
        servicesConfig,
        profilesToApply,
      );
      const profilesToApplyById = new Map(profilesToApply);
      const servicesToApplyById = new Map(servicesToApply);
      // First remove any references to profiles and services that might be deleted.
      self.selectedService = undefined;
      services.clear();
      profiles.clear();
      // Delete all services that may depend on profiles that will be delete.
      deleteStaleModels(servicesById, servicesToApplyById);
      // Update existing profiles and add new profiles.
      applySettings(profilesById, profilesToApplyById);
      // Update existing services and add new services. This will make sure that no service
      // depends on a profile that will be deleted.
      applySettings(servicesById, servicesToApplyById);
      // Now it's safe to delete stale profiles.
      deleteStaleModels(profilesById, profilesToApplyById);
      // We are ready to build new profile and service lists from the new models.
      pushReferences(profiles, profilesToApply);
      pushReferences(services, servicesToApply);
      // Global settings may refer to particular profiles or services.
      applySnapshot(settings, settingsToApply);
      // Restore service selection (if applicable).
      let newSelectedService;
      if (selectedServiceId !== undefined) {
        newSelectedService = servicesById.get(selectedServiceId);
      }
      if (newSelectedService === undefined && services.length > 0) {
        [newSelectedService] = services;
      }
      self.selectedService = newSelectedService;
    },
    setShouldUseDarkColors(shouldUseDarkColors: boolean): void {
      self.shouldUseDarkColors = shouldUseDarkColors;
    },
    setSelectedServiceId(serviceId: string): void {
      const serviceInstance = resolveIdentifier(service, self, serviceId);
      if (serviceInstance === undefined) {
        log.warn('Trying to select unknown service', serviceId);
        return;
      }
      self.selectedService = serviceInstance;
      log.debug('Selected service', serviceId);
    },
  }));

export interface SharedStore extends Instance<typeof sharedStore> {}

export type {
  SharedStoreSnapshotIn,
  SharedStoreSnapshotOut,
} from '@sophie/shared';