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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
use std::borrow::Borrow;
use std::collections::HashMap;
use std::ffi::OsString;
use std::fmt::Display;
use std::path::{Path, PathBuf};

use pathdiff::diff_paths;

use crate::configuration_file::{ConfigurationFile, WriteError};
use crate::io::FromFileError;
use crate::monorepo_manifest::{EnumeratePackageManifestsError, MonorepoManifest};
use crate::out_of_date_project_references::{
    AllOutOfDateTypescriptConfig, OutOfDatePackageProjectReferences,
    OutOfDateParentProjectReferences, OutOfDateTypescriptConfig,
};
use crate::package_manifest::PackageManifest;
use crate::types::{Directory, PackageName};
use crate::typescript_config::{
    TypescriptConfig, TypescriptParentProjectReference, TypescriptProjectReference,
};

#[derive(Debug)]
#[non_exhaustive]
pub struct LinkError {
    pub kind: LinkErrorKind,
}

impl Display for LinkError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "error linking TypeScript project references")
    }
}

impl std::error::Error for LinkError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match &self.kind {
            LinkErrorKind::EnumeratePackageManifests(err) => Some(err),
            LinkErrorKind::FromFile(err) => Some(err),
            LinkErrorKind::Write(err) => Some(err),
            LinkErrorKind::InvalidUtf8(err) => Some(err),
        }
    }
}

impl From<EnumeratePackageManifestsError> for LinkError {
    fn from(err: EnumeratePackageManifestsError) -> Self {
        Self {
            kind: LinkErrorKind::EnumeratePackageManifests(err),
        }
    }
}

impl From<FromFileError> for LinkError {
    fn from(err: FromFileError) -> Self {
        Self {
            kind: LinkErrorKind::FromFile(err),
        }
    }
}

impl From<WriteError> for LinkError {
    fn from(err: WriteError) -> Self {
        Self {
            kind: LinkErrorKind::Write(err),
        }
    }
}

impl From<InvalidUtf8Error> for LinkError {
    fn from(err: InvalidUtf8Error) -> Self {
        Self {
            kind: LinkErrorKind::InvalidUtf8(err),
        }
    }
}

#[derive(Debug)]
pub enum LinkErrorKind {
    #[non_exhaustive]
    EnumeratePackageManifests(EnumeratePackageManifestsError),
    #[non_exhaustive]
    FromFile(FromFileError),
    #[non_exhaustive]
    InvalidUtf8(InvalidUtf8Error),
    #[non_exhaustive]
    Write(WriteError),
}

#[derive(Debug)]
pub struct InvalidUtf8Error(OsString);

impl Display for InvalidUtf8Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "path cannot be expressed as UTF-8: {:?}", self.0)
    }
}

impl std::error::Error for InvalidUtf8Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        None
    }
}

fn key_children_by_parent<M>(
    mut accumulator: HashMap<Directory, Vec<String>>,
    package_manifest: M,
) -> Result<HashMap<Directory, Vec<String>>, InvalidUtf8Error>
where
    M: Borrow<PackageManifest>,
{
    let mut path_so_far = PathBuf::new();
    for component in package_manifest.borrow().directory().iter() {
        let children = accumulator
            .entry(Directory::unchecked_from_path(path_so_far.clone()))
            .or_default();

        let new_child = component
            .to_str()
            .map(ToOwned::to_owned)
            .ok_or_else(|| InvalidUtf8Error(component.to_owned()))?;
        // DISCUSS: when would this list already contain the child?
        if !children.contains(&new_child) {
            children.push(new_child);
        }

        path_so_far.push(component);
    }
    Ok(accumulator)
}

fn create_project_references(mut children: Vec<String>) -> Vec<TypescriptProjectReference> {
    // Sort the TypeScript project references for deterministic file contents.
    // This minimizes diffs since the tsconfig.json files are stored in version control.
    children.sort_unstable();
    children
        .into_iter()
        .map(|path| TypescriptProjectReference { path })
        .collect()
}

// Create a tsconfig.json file in each parent directory to an internal package.
// This permits us to compile the monorepo from the top down.
fn link_children_packages(
    root: &Directory,
    package_manifests_by_package_name: &HashMap<PackageName, PackageManifest>,
) -> Result<(), LinkError> {
    out_of_date_parent_project_references(root, package_manifests_by_package_name)?.try_for_each(
        |maybe_parent_project_references| -> Result<(), LinkError> {
            let OutOfDateParentProjectReferences {
                mut tsconfig,
                desired_references,
            } = maybe_parent_project_references?;
            tsconfig.contents.references = desired_references;
            Ok(TypescriptParentProjectReference::write(root, tsconfig)?)
        },
    )
}

fn link_package_dependencies(
    root: &Directory,
    package_manifests_by_package_name: &HashMap<PackageName, PackageManifest>,
) -> Result<(), LinkError> {
    out_of_date_package_project_references(root, package_manifests_by_package_name)?
        .map(
            |maybe_package_project_references| -> Result<Option<_>, FromFileError> {
                let OutOfDatePackageProjectReferences {
                    mut tsconfig,
                    desired_references,
                } = maybe_package_project_references?;
                // Compare the current references against the desired references
                let current_project_references = &tsconfig
                    .contents
                    .get("references")
                    .map(|value| {
                        serde_json::from_value::<Vec<TypescriptProjectReference>>(value.clone())
                            .expect("value starting as JSON should be deserializable")
                    })
                    .unwrap_or_default();

                let needs_update = !current_project_references.eq(&desired_references);
                if !needs_update {
                    return Ok(None);
                }

                // Update the current tsconfig with the desired references
                tsconfig.contents.insert(
                    String::from("references"),
                    serde_json::to_value(desired_references).expect(
                        "should be able to express desired TypeScript project references as JSON",
                    ),
                );

                Ok(Some(tsconfig))
            },
        )
        .filter_map(Result::transpose)
        .map(|maybe_tsconfig| -> Result<(), LinkError> {
            let tsconfig = maybe_tsconfig?;
            Ok(TypescriptConfig::write(root, tsconfig)?)
        })
        .collect::<Result<Vec<_>, _>>()?;
    Ok(())
}

pub fn modify<P>(root: P) -> Result<(), LinkError>
where
    P: AsRef<Path>,
{
    fn inner(root: &Path) -> Result<(), LinkError> {
        let lerna_manifest = MonorepoManifest::from_directory(root)?;
        let package_manifests_by_package_name =
            lerna_manifest.package_manifests_by_package_name()?;
        link_children_packages(&lerna_manifest.root, &package_manifests_by_package_name)?;
        link_package_dependencies(&lerna_manifest.root, &package_manifests_by_package_name)?;
        // TODO(7): create `tsconfig.settings.json` files
        Ok(())
    }
    inner(root.as_ref())
}

#[derive(Debug)]
#[non_exhaustive]
pub struct LinkLintError {
    pub kind: LinkLintErrorKind,
}

impl Display for LinkLintError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match &self.kind {
            LinkLintErrorKind::ProjectReferencesOutOfDate(out_of_date_references) => {
                writeln!(f, "TypeScript project references are not up-to-date")?;
                writeln!(f, "{}", out_of_date_references)
            }
            _ => write!(f, "error linking TypeScript project references"),
        }
    }
}

impl std::error::Error for LinkLintError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match &self.kind {
            LinkLintErrorKind::EnumeratePackageManifests(err) => Some(err),
            LinkLintErrorKind::FromFile(err) => Some(err),
            LinkLintErrorKind::ProjectReferencesOutOfDate(_) => None,
            LinkLintErrorKind::InvalidUtf8(err) => Some(err),
        }
    }
}

impl From<EnumeratePackageManifestsError> for LinkLintError {
    fn from(err: EnumeratePackageManifestsError) -> Self {
        Self {
            kind: LinkLintErrorKind::EnumeratePackageManifests(err),
        }
    }
}

impl From<FromFileError> for LinkLintError {
    fn from(err: FromFileError) -> Self {
        Self {
            kind: LinkLintErrorKind::FromFile(err),
        }
    }
}

impl From<InvalidUtf8Error> for LinkLintError {
    fn from(err: InvalidUtf8Error) -> Self {
        Self {
            kind: LinkLintErrorKind::InvalidUtf8(err),
        }
    }
}

impl From<AllOutOfDateTypescriptConfig> for LinkLintError {
    fn from(err: AllOutOfDateTypescriptConfig) -> Self {
        Self {
            kind: LinkLintErrorKind::ProjectReferencesOutOfDate(err),
        }
    }
}

#[derive(Debug)]
pub enum LinkLintErrorKind {
    #[non_exhaustive]
    EnumeratePackageManifests(EnumeratePackageManifestsError),
    #[non_exhaustive]
    FromFile(FromFileError),
    #[non_exhaustive]
    InvalidUtf8(InvalidUtf8Error),
    // TODO: augment this error with information for a useful error message
    #[non_exhaustive]
    ProjectReferencesOutOfDate(AllOutOfDateTypescriptConfig),
}

fn out_of_date_parent_project_references<'a>(
    root: &'a Directory,
    package_manifests_by_package_name: &'a HashMap<PackageName, PackageManifest>,
) -> Result<
    impl Iterator<Item = Result<OutOfDateParentProjectReferences, FromFileError>> + 'a,
    InvalidUtf8Error,
> {
    let iter = package_manifests_by_package_name
        .values()
        .try_fold(HashMap::default(), key_children_by_parent)?
        .into_iter()
        .map(move |(directory, children)| {
            let desired_references = create_project_references(children);
            let tsconfig = TypescriptParentProjectReference::from_directory(&root, directory)?;
            let current_project_references = &tsconfig.contents.references;
            let needs_update = !current_project_references.eq(&desired_references);
            Ok(match needs_update {
                true => Some(OutOfDateParentProjectReferences {
                    tsconfig,
                    desired_references,
                }),
                false => None,
            })
        })
        .filter_map(Result::transpose);
    Ok(iter)
}

fn out_of_date_package_project_references<'a>(
    root: &'a Directory,
    package_manifests_by_package_name: &'a HashMap<PackageName, PackageManifest>,
) -> Result<
    impl Iterator<Item = Result<OutOfDatePackageProjectReferences, FromFileError>> + 'a,
    InvalidUtf8Error,
> {
    let iter = package_manifests_by_package_name
        .values()
        .map(move |package_manifest| {
            let package_directory = package_manifest.directory();
            let tsconfig = TypescriptConfig::from_directory(&root, package_directory.to_owned())?;
            let internal_dependencies =
                package_manifest.internal_dependencies_iter(&package_manifests_by_package_name);

            let desired_references: Vec<TypescriptProjectReference> = {
                let mut typescript_project_references: Vec<String> = internal_dependencies
                    .into_iter()
                    .map(|dependency| {
                        diff_paths(dependency.directory(), package_manifest.directory())
                            .expect(
                                "Unable to calculate a relative path to dependency from package",
                            )
                            .to_str()
                            .expect("Path not valid UTF-8 encoded")
                            .to_string()
                    })
                    .collect::<Vec<_>>();
                // REFACTOR: can drop a `collect` if we implement Ord on TypescriptProjectReference
                typescript_project_references.sort_unstable();

                typescript_project_references
                    .into_iter()
                    .map(|path| TypescriptProjectReference { path })
                    .collect()
            };

            // Compare the current references against the desired references
            let current_project_references = &tsconfig
                .contents
                .get("references")
                .map(|value| {
                    serde_json::from_value::<Vec<TypescriptProjectReference>>(value.clone())
                        .expect("value starting as JSON should be serializable")
                })
                .unwrap_or_default();

            let needs_update = !current_project_references.eq(&desired_references);
            Ok(match needs_update {
                true => Some(OutOfDatePackageProjectReferences {
                    tsconfig,
                    desired_references,
                }),
                false => None,
            })
        })
        .filter_map(Result::transpose);

    Ok(iter)
}

pub fn lint<P>(root: P) -> Result<(), LinkLintError>
where
    P: AsRef<Path>,
{
    fn inner(root: &Path) -> Result<(), LinkLintError> {
        let monorepo_manifest = MonorepoManifest::from_directory(root)?;
        let package_manifests_by_package_name =
            monorepo_manifest.package_manifests_by_package_name()?;

        let is_children_link_success = out_of_date_parent_project_references(
            &monorepo_manifest.root,
            &package_manifests_by_package_name,
        )?
        .map(
            |result| -> Result<OutOfDateTypescriptConfig, FromFileError> { result.map(Into::into) },
        );

        let is_dependencies_link_success = out_of_date_package_project_references(
            &monorepo_manifest.root,
            &package_manifests_by_package_name,
        )?
        .map(
            |result| -> Result<OutOfDateTypescriptConfig, FromFileError> { result.map(Into::into) },
        );

        let lint_issues: AllOutOfDateTypescriptConfig = is_children_link_success
            .chain(is_dependencies_link_success)
            .collect::<Result<_, _>>()?;

        match lint_issues.is_empty() {
            true => Ok(()),
            false => Err(lint_issues)?,
        }
    }
    inner(root.as_ref())
}