-
-
Notifications
You must be signed in to change notification settings - Fork 252
/
ReloadIndex.ts
282 lines (262 loc) · 8.62 KB
/
ReloadIndex.ts
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
import {
ConfigEvents,
DEngineClient,
DVault,
ERROR_SEVERITY,
FOLDERS,
IDendronError,
isNotUndefined,
NoteUtils,
SchemaUtils,
VaultUtils,
WorkspaceEvents,
DuplicateNoteError,
errorsList,
} from "@dendronhq/common-all";
import {
getDurationMilliseconds,
note2File,
schemaModuleOpts2File,
vault2Path,
} from "@dendronhq/common-server";
import { DoctorActionsEnum, DoctorService } from "@dendronhq/engine-server";
import fs from "fs-extra";
import _ from "lodash";
import path from "path";
import { ProgressLocation, window } from "vscode";
import { DENDRON_COMMANDS } from "../constants";
import { ExtensionProvider } from "../ExtensionProvider";
import { Logger } from "../logger";
import { IEngineAPIService } from "../services/EngineAPIServiceInterface";
import { AnalyticsUtils } from "../utils/analytics";
import { MessageSeverity, VSCodeUtils } from "../vsCodeUtils";
import { BasicCommand } from "./base";
enum AutoFixAction {
CREATE_ROOT_SCHEMA = "create root schema",
CREATE_ROOT_NOTE = "create root note",
}
export const FIX_CONFIG_SELF_CONTAINED = "Fix configuration";
function categorizeActions(actions: (AutoFixAction | undefined)[]) {
return {
[AutoFixAction.CREATE_ROOT_NOTE]: actions.filter(
(item) => item === AutoFixAction.CREATE_ROOT_NOTE
).length,
[AutoFixAction.CREATE_ROOT_SCHEMA]: actions.filter(
(item) => item === AutoFixAction.CREATE_ROOT_SCHEMA
).length,
};
}
type ReloadIndexCommandOpts = {
silent?: boolean;
};
export class ReloadIndexCommand extends BasicCommand<
ReloadIndexCommandOpts,
DEngineClient | undefined
> {
key = DENDRON_COMMANDS.RELOAD_INDEX.key;
silent = true;
/** Create the root schema if it is missing. */
private async createRootSchemaIfMissing(
wsRoot: string,
vault: DVault
): Promise<undefined | AutoFixAction> {
const ctx = "ReloadIndex.createRootSchemaIfMissing";
const vaultDir = vault2Path({ wsRoot, vault });
const rootSchemaPath = path.join(vaultDir, "root.schema.yml");
// If it already exists, nothing to do
if (await fs.pathExists(rootSchemaPath)) return;
// If this is just a misconfigured self contained vault, skip it because we'll need to fix the config
if (
await fs.pathExists(path.join(vaultDir, FOLDERS.NOTES, "root.schema.yml"))
)
return;
try {
const schema = SchemaUtils.createRootModule({ vault });
this.L.info({ ctx, vaultDir, msg: "creating root schema" });
await schemaModuleOpts2File(schema, vaultDir, "root");
return AutoFixAction.CREATE_ROOT_SCHEMA;
} catch (err) {
this.L.info({
ctx,
vaultDir,
msg: "Error when creating root schema",
err,
});
return;
}
}
/** Creates the root note if it is missing. */
private async createRootNoteIfMissing(
wsRoot: string,
vault: DVault
): Promise<undefined | AutoFixAction> {
const ctx = "ReloadIndex.createRootNoteIfMissing";
const vaultDir = vault2Path({ wsRoot, vault });
const rootNotePath = path.join(vaultDir, "root.md");
// If it already exists, nothing to do
if (await fs.pathExists(rootNotePath)) return;
// If this is just a misconfigured self contained vault, skip it because we'll need to fix the config
if (await fs.pathExists(path.join(vaultDir, FOLDERS.NOTES, "root.md")))
return;
try {
const note = NoteUtils.createRoot({ vault });
this.L.info({ ctx, vaultDir, msg: "creating root note" });
await note2File({
note,
vault,
wsRoot,
});
return AutoFixAction.CREATE_ROOT_NOTE;
} catch (err) {
this.L.info({ ctx, vaultDir, msg: "Error when creating root note", err });
return;
}
}
/** Checks if there are any self contained vaults that aren't marked correctly, and prompts the user to fix the configuration. */
static async checkAndPromptForMisconfiguredSelfContainedVaults({
engine,
}: {
engine: IEngineAPIService;
}) {
const ctx = "checkAndPromptForMisconfiguredSelfContainedVaults";
const { wsRoot, vaults } = ExtensionProvider.getDWorkspace();
const doctor = new DoctorService();
const vaultsToFix = await doctor.findMisconfiguredSelfContainedVaults(
wsRoot,
vaults
);
const fixConfig = FIX_CONFIG_SELF_CONTAINED;
if (vaultsToFix.length > 0) {
Logger.info({
ctx,
numVaultsToFix: vaultsToFix.length,
});
let message: string;
let detail: string | undefined;
if (vaultsToFix.length === 1) {
message = `Vault "${VaultUtils.getName(
vaultsToFix[0]
)}" needs to be marked as a self contained vault in your configuration file.`;
} else {
message = `${vaultsToFix.length} vaults need to be marked as self contained vaults in your configuration file`;
}
AnalyticsUtils.track(ConfigEvents.MissingSelfContainedVaultsMessageShow, {
vaultsToFix: vaultsToFix.length,
});
const pick = await window.showWarningMessage(
message,
{
detail,
},
fixConfig,
"Ignore for now"
);
Logger.info({
ctx,
msg: "Used picked an option in the fix prompt",
pick,
});
if (pick === fixConfig) {
AnalyticsUtils.trackForNextRun(
ConfigEvents.MissingSelfContainedVaultsMessageAccept
);
await doctor.executeDoctorActions({
action: DoctorActionsEnum.FIX_SELF_CONTAINED_VAULT_CONFIG,
engine,
});
Logger.info({
ctx,
msg: "Fixing vaults done!",
});
// Need to reload because the vaults loaded are incorrect now
VSCodeUtils.reloadWindow();
}
}
doctor.dispose();
}
/**
* Update index
* @param opts
*/
async execute(
opts?: ReloadIndexCommandOpts
): Promise<DEngineClient | undefined> {
const ctx = "ReloadIndex.execute";
this.L.info({ ctx, msg: "enter" });
const ws = ExtensionProvider.getDWorkspace();
let initError: IDendronError | undefined;
const { wsRoot, engine } = ws;
// Check if there are any misconfigured self contained vaults.
// Deliberately not awaiting this to avoid blocking the reload
ReloadIndexCommand.checkAndPromptForMisconfiguredSelfContainedVaults({
engine: ExtensionProvider.getEngine(),
});
// Fix up any broken vaults
const reloadIndex = async () => {
const autoFixActions = await Promise.all(
engine.vaults.flatMap((vault) => {
return [
this.createRootSchemaIfMissing(wsRoot, vault),
this.createRootNoteIfMissing(wsRoot, vault),
];
})
);
if (autoFixActions.filter(isNotUndefined).length > 0) {
AnalyticsUtils.track(WorkspaceEvents.AutoFix, {
...categorizeActions(autoFixActions),
nonFatalInitError:
initError && initError.severity === ERROR_SEVERITY.MINOR,
});
}
const start = process.hrtime();
const { error } = await engine.init();
const durationEngineInit = getDurationMilliseconds(start);
this.L.info({ ctx, durationEngineInit });
// if fatal, stop initialization
if (error && error.severity !== ERROR_SEVERITY.MINOR) {
this.L.error({ ctx, error, msg: "unable to initialize engine" });
return;
}
if (error) {
// There may be one or more errors,
const errors = errorsList(error);
errors.forEach((error) => {
if (DuplicateNoteError.isDuplicateNoteError(error) && error.code) {
VSCodeUtils.showMessage(MessageSeverity.WARN, error.message, {});
AnalyticsUtils.track(WorkspaceEvents.DuplicateNoteFound, {
source: this.key,
});
this.L.info({ ctx, error, msg: "Duplicate note IDs found" });
} else {
// Warn about any errors not handled above
this.L.error({
ctx,
error,
msg: `Initialization error: ${error.message}`,
});
}
});
if (errors.length === 0) {
// For backwards compatibility, warn if there are warnings that are
// non-fatal errors not covered by the new error architecture
this.L.error({ ctx, error, msg: "init error" });
}
}
return autoFixActions;
};
if (!(opts && !opts.silent)) {
await reloadIndex();
} else {
await window.withProgress(
{
location: ProgressLocation.Notification,
title: "Reloading Index...",
cancellable: false,
},
reloadIndex
);
}
this.L.info({ ctx, msg: "exit", initError });
return engine;
}
}