aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/watch.js
blob: 91f3583b56c636301951582c267eddf6006b8480 (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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
import { spawn } from 'node:child_process';
import path from 'node:path';

import { watch } from 'chokidar';
import electronPath from 'electron';
import { build as esbuildBuild } from 'esbuild';
import { createServer } from 'vite';

import fileUrlToDirname from '../config/fileUrlToDirname.js';

/** @type {string} */
const thisDir = fileUrlToDirname(import.meta.url);

/** @type {string} */
const sharedModule = path.join(thisDir, '../packages/shared/dist/index.mjs');

/** @type {string} */
const serviceSharedModule = path.join(
  thisDir,
  '../packages/service-shared/dist/index.mjs',
);

/** @type {RegExp[]} */
const stderrIgnorePatterns = [
  // warning about devtools extension
  // https://github.com/cawa-93/vite-electron-builder/issues/492
  // https://github.com/MarshallOfSound/electron-devtools-installer/issues/143
  /ExtensionLoadWarning/,
  // GPU sandbox error with the mesa GLSL cache
  // https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=918433
  /InitializeSandbox\(\) called with multiple threads in process gpu-process/,
];

/**
 * @param {string} packageName
 * @param {string[]} [extraPaths]
 * @param {() => void} [callback]
 * @returns {Promise<void>}
 */
async function setupEsbuildWatcher(packageName, extraPaths, callback) {
  /** @type {{ default: import('esbuild').BuildOptions }} */
  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- Read untyped config file.
  const { default: config } = await import(
    `../packages/${packageName}/esbuild.config.js`
  );
  config.logLevel = 'info';
  config.incremental = true;

  const incrementalBuild = await esbuildBuild(config);
  const paths = [
    path.join(thisDir, `../packages/${packageName}/src`),
    ...(extraPaths || []),
  ];
  const watcher = watch(paths, {
    ignored: /(^|[/\\])\.|__(tests|mocks)__|\.(spec|test)\.[jt]sx?$/,
    ignoreInitial: true,
    persistent: true,
  });

  if (callback) {
    callback();
  }

  /**
   * @returns {Promise<void>}
   */
  async function rebuild() {
    try {
      await incrementalBuild.rebuild?.();
    } catch (error) {
      if (typeof error === 'object' && error !== null && 'errors' in error) {
        const { errors } = /** @type {{ errors: unknown }} */ (error);
        if (Array.isArray(errors)) {
          const errCount = errors.length;
          console.error(
            '\uD83D\uDD25',
            errCount,
            errCount > 1 ? 'errors' : 'error',
            'while rebuilding package',
            packageName,
          );
          return;
        }
      }
      console.error(
        '\uD83D\uDD25',
        'error while rebuilding package',
        packageName,
        error,
      );
      return;
    }
    if (callback) {
      console.log(`\u26A1 Reloading package ${packageName}`);
      callback();
    }
  }

  watcher.on('change', () => {
    rebuild().catch((error) => {
      console.error('Unexpected error while rebuilding', error);
    });
  });
}

/**
 * @param {string} packageName
 * @returns {Promise<import('vite').ViteDevServer>}
 */
async function setupDevServer(packageName) {
  const viteDevServer = await createServer({
    build: {
      watch: {
        skipWrite: true,
        clearScreen: false,
      },
    },
    configFile: path.join(thisDir, `../packages/${packageName}/vite.config.js`),
  });
  await viteDevServer.listen();
  return viteDevServer;
}

/**
 * @param {(event: import('vite').HMRPayload) => void} sendEvent
 * @returns {Promise<void>}
 */
function setupPreloadPackageWatcher(sendEvent) {
  return setupEsbuildWatcher('preload', [sharedModule], () => {
    sendEvent({
      type: 'full-reload',
    });
  });
}

/**
 * @param {string} packageName
 * @param {(event: import('vite').HMRPayload) => void} sendEvent
 * @returns {Promise<void>}
 */
function setupServicePackageWatcher(packageName, sendEvent) {
  return setupEsbuildWatcher(packageName, [serviceSharedModule], () => {
    sendEvent({
      type: 'custom',
      event: 'sophie:reload-services',
    });
  });
}

/**
 * @param {import('vite').ViteDevServer} viteDevServer
 * @returns {Promise<void>}
 */
function setupMainPackageWatcher(viteDevServer) {
  // Write a value to an environment variable to pass it to the main process.
  const {
    config: {
      server: { port, https, host },
    },
  } = viteDevServer;
  const protocol = `http${https ? 's' : ''}:`;
  const hostOrDefault = typeof host === 'string' ? host : 'localhost';
  const portOrDefault = port || 3000;
  process.env.VITE_DEV_SERVER_URL = `${protocol}//${hostOrDefault}:${portOrDefault}/`;

  /** @type {import('child_process').ChildProcessByStdio<null, null, import('stream').Readable>
    | undefined} */
  let spawnProcess;

  return setupEsbuildWatcher(
    'main',
    [serviceSharedModule, sharedModule],
    () => {
      if (spawnProcess !== undefined) {
        spawnProcess.kill('SIGINT');
        spawnProcess = undefined;
      }

      spawnProcess = spawn(String(electronPath), ['.'], {
        stdio: ['inherit', 'inherit', 'pipe'],
      });

      spawnProcess.stderr.on('data', (/** @type {Buffer} */ data) => {
        const stderrString = data.toString('utf-8').trimEnd();
        if (!stderrIgnorePatterns.some((r) => r.test(stderrString))) {
          console.error(stderrString);
        }
      });
    },
  );
}

/**
 * @returns {Promise<void>}
 */
async function setupDevEnvironment() {
  process.env.MODE = 'development';
  process.env.NODE_ENV = 'development';

  /** @type {import('vite').ViteDevServer | undefined} */
  let viteDevServer;

  /**
   * @param {import('vite').HMRPayload} event
   * @returns {void}
   */
  function sendEvent(event) {
    if (viteDevServer !== undefined) {
      viteDevServer.ws.send(event);
    }
  }

  /**
   * @returns {Promise<void>}
   */
  async function startDevServer() {
    viteDevServer = await setupDevServer('renderer');
  }

  /**
   * @returns {Promise<void>}
   */
  async function watchRendererPackages() {
    await setupEsbuildWatcher('shared');
    await Promise.all([
      setupPreloadPackageWatcher(sendEvent),
      startDevServer(),
    ]);
  }

  /**
   * @returns {Promise<void>}
   */
  async function watchServicePackages() {
    await setupEsbuildWatcher('service-shared');
    await Promise.all([
      setupServicePackageWatcher('service-inject', sendEvent),
      setupServicePackageWatcher('service-preload', sendEvent),
    ]);
  }

  await Promise.all([watchRendererPackages(), watchServicePackages()]);

  if (viteDevServer === undefined) {
    console.error('Failed to create vite dev server');
    return;
  }

  console.log('\uD83C\uDF80 Sophie is starting up');
  await setupMainPackageWatcher(viteDevServer);
}

setupDevEnvironment().catch((error) => {
  console.error(error);
  process.exit(1);
});