releasaurus-core 0.17.0

A comprehensive release automation tool that streamlines the software release process across multiple programming languages and forge platforms
Documentation
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
use std::{
    collections::{HashMap, HashSet},
    rc::Rc,
};

use chrono::Utc;
use serde::{Deserialize, Serialize};

use crate::{
    analyzer::Analyzer,
    error::{ReleasaurusError, Result},
    forge::{
        config::DEFAULT_PR_BRANCH_PREFIX,
        manager::ForgeManager,
        request::{
            CreatePrRequest, CreateReleaseBranchRequest, FileChange,
            FileUpdateType, ForgeCommit, GetPrRequest, PullRequest,
        },
    },
    orchestrator::{
        commits::CommitsCore,
        config::OrchestratorConfig,
        package::{
            analyzed::AnalyzedPackage,
            prepared::PreparedPackage,
            releasable::{
                ReleasablePackage, ReleasableSubPackage,
                SerializableReleasablePackage,
            },
            releasable_builder::ReleasablePackageBuilder,
            release_pr::{PRBundle, ReleasePRPackage},
            resolved::{ResolvedPackage, ResolvedPackageHash},
        },
        pr_body::{extract_preserved_header_footer, normalize_html_id},
    },
    updater::manager::UpdateManager,
};

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct PRMetadataFields {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tag: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub notes: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tag_compare_link: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sha_compare_link: Option<String>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct PRMetadata {
    pub metadata: PRMetadataFields,
}

/// Result of `create_pr_branches`: the forge request paired with the existing
/// open PR for that branch (if one was found during `release_pr_packages_by_branch`).
pub struct PrBranchResult {
    pub request: CreatePrRequest,
    pub existing_pr: Option<PullRequest>,
}

pub struct Core {
    config: Rc<OrchestratorConfig>,
    forge: Rc<ForgeManager>,
    package_configs: Rc<ResolvedPackageHash>,
    commits_core: CommitsCore,
}

impl Core {
    pub fn new(
        config: Rc<OrchestratorConfig>,
        forge: Rc<ForgeManager>,
        package_configs: Rc<ResolvedPackageHash>,
    ) -> Self {
        Self {
            commits_core: CommitsCore::new(
                Rc::clone(&config),
                Rc::clone(&forge),
                Rc::clone(&package_configs),
            ),
            config,
            forge,
            package_configs,
        }
    }

    pub async fn generate_prepared_with_dummy_commit(
        &self,
        targets: Option<Vec<String>>,
    ) -> Result<Vec<PreparedPackage>> {
        let mut prepared = vec![];

        for (name, pkg) in self.package_configs.hash().iter() {
            // This is not added to changelog or tracked anywhere so we can just
            // use a fake dummy commit to trigger a patch version update
            let pkg_commit = ForgeCommit {
                id: "dummy".into(),
                short_id: "dummy".into(),
                message: "fix: dummy commit".into(),
                timestamp: Utc::now().timestamp(),
                files: vec![
                    pkg.normalized_full_path
                        .join("dummy.txt")
                        .to_string_lossy()
                        .to_string(),
                ],
                ..ForgeCommit::default()
            };

            let current_tag = self
                .forge
                .get_latest_tag_for_prefix(
                    &pkg.tag_prefix,
                    &self.config.base_branch,
                )
                .await?;

            if current_tag.is_none() {
                log::warn!(
                    "package {} has not been tagged yet: cannot start-next: skipping",
                    pkg.name
                );
                continue;
            }

            if let Some(list) = targets.as_ref()
                && list.contains(name)
            {
                prepared.push(PreparedPackage {
                    name: name.clone(),
                    current_tag,
                    commits: vec![pkg_commit],
                });
            } else if targets.is_none() {
                prepared.push(PreparedPackage {
                    name: name.clone(),
                    current_tag,
                    commits: vec![pkg_commit],
                });
            }
        }

        Ok(prepared)
    }

    pub async fn prepare_packages(
        &self,
        target: Option<&str>,
    ) -> Result<Vec<PreparedPackage>> {
        let mut prepared_packages = vec![];

        let (commits, tags) = self
            .commits_core
            .get_commits_for_all_packages(target)
            .await?;

        let commit_hash_set: HashSet<_> = commits.iter().collect();

        for (name, package) in self.package_configs.hash().iter() {
            if let Some(target) = target
                && package.name != target
            {
                continue;
            }

            let tag_info = tags.get(name);
            let current_tag = tag_info.and_then(|i| i.tag.clone());
            let is_graduating_to_stable =
                tag_info.map(|i| i.graduating_to_stable).unwrap_or_default();

            let mut commits = self.commits_core.filter_commits_for_package(
                package,
                current_tag.as_ref(),
                &commits,
            );

            if self.config.changelog.aggregate_prereleases
                && is_graduating_to_stable
            {
                let additional = self
                    .commits_core
                    .fetch_additional_commits_for_prerelease_aggregation(
                        package,
                    )
                    .await?;
                commits.extend(
                    additional
                        .into_iter()
                        .filter(|c| !commit_hash_set.contains(c)),
                );
                commits.sort_by_key(|c| c.timestamp);
            }

            prepared_packages.push(PreparedPackage {
                name: name.clone(),
                current_tag,
                commits,
            })
        }

        Ok(prepared_packages)
    }

    pub fn analyze_packages(
        &self,
        packages: Vec<PreparedPackage>,
    ) -> Result<Vec<AnalyzedPackage>> {
        let mut analyzed_packages = vec![];

        for pkg in packages.into_iter() {
            let config = self.package_configs.get(&pkg.name)?;
            let analyzer = Analyzer::new(&config.analyzer_config)?;
            let release = analyzer.analyze(pkg.commits, pkg.current_tag)?;
            let analyzed = AnalyzedPackage {
                name: pkg.name.clone(),
                release,
            };
            analyzed_packages.push(analyzed);
        }

        Ok(analyzed_packages)
    }

    pub async fn releasable_packages(
        &self,
        packages: Vec<AnalyzedPackage>,
    ) -> Result<Vec<ReleasablePackage>> {
        self.build_releasable_packages(packages).await
    }

    pub async fn full_serializable_releasable_packages(
        &self,
        packages: Vec<AnalyzedPackage>,
    ) -> Result<Vec<SerializableReleasablePackage>> {
        self.build_releasable_packages(packages).await
    }

    pub fn release_pr_packages(
        &self,
        packages: Vec<ReleasablePackage>,
    ) -> Result<Vec<ReleasePRPackage>> {
        let mut finalized = vec![];
        for target in packages.iter() {
            let target_config = self.package_configs.get(&target.name)?;

            let mut release_branch = format!(
                "{}-{}",
                DEFAULT_PR_BRANCH_PREFIX, self.config.base_branch
            );

            if self.config.separate_pull_requests {
                release_branch = format!("{release_branch}-{}", target.name);
            }

            let releasable_refs: Vec<&ReleasablePackage> =
                packages.iter().collect();

            // gather other packages related to target package that may be in
            // same workspace
            let workspace_packages =
                self.related_packages(target, target_config, &releasable_refs)?;

            log::info!(
                "Package: {}: Found {} other packages for workspace root: {}",
                target.name,
                workspace_packages.len(),
                target_config.normalized_workspace_root.to_string_lossy()
            );

            let mut file_changes =
                UpdateManager::get_package_manifest_file_changes(
                    target,
                    &releasable_refs,
                )?;

            file_changes
                .push(self.changelog_file_change(target, target_config));

            finalized.push(ReleasePRPackage {
                name: target.name.clone(),
                tag: target.tag.clone(),
                notes: target.notes.clone(),
                tag_compare_link: target.tag_compare_link.clone(),
                sha_compare_link: target.sha_compare_link.clone(),
                file_changes,
                release_branch,
            });
        }

        Ok(finalized)
    }

    pub async fn release_pr_packages_by_branch(
        &self,
        packages: Vec<ReleasablePackage>,
    ) -> Result<HashMap<String, PRBundle>> {
        let release_prs = self.release_pr_packages(packages)?;

        let mut map: HashMap<String, Vec<ReleasePRPackage>> = HashMap::new();

        for pkg in release_prs {
            let list = map.get_mut(&pkg.release_branch);

            if let Some(list) = list {
                list.push(pkg)
            } else {
                map.insert(pkg.release_branch.clone(), vec![pkg]);
            };
        }

        let mut bundles: HashMap<String, PRBundle> = HashMap::new();

        for (branch, packages) in map {
            let existing_pr = self
                .forge
                .get_open_release_pr(GetPrRequest {
                    head_branch: branch.clone(),
                    base_branch: self.config.base_branch.clone(),
                })
                .await?;

            bundles.insert(
                branch,
                PRBundle {
                    existing_pr,
                    packages,
                },
            );
        }

        Ok(bundles)
    }

    pub async fn create_pr_branches(
        &self,
        bundles: HashMap<String, PRBundle>,
    ) -> Result<Vec<PrBranchResult>> {
        let mut pr_results = vec![];

        for (release_branch, bundle) in bundles.into_iter() {
            if let Some(pending_release) = self
                .forge
                .get_merged_release_pr(GetPrRequest {
                    base_branch: self.config.base_branch.clone(),
                    head_branch: release_branch.clone(),
                })
                .await?
            {
                return Err(ReleasaurusError::pending_release(
                    release_branch.clone(),
                    pending_release.number,
                ));
            }

            let file_changes: Vec<FileChange> = bundle
                .packages
                .iter()
                .flat_map(|p| p.file_changes.clone())
                .collect();

            let message =
                self.release_message_for_pr_package_list(&bundle.packages);

            self.forge
                .create_release_branch(CreateReleaseBranchRequest {
                    base_branch: self.config.base_branch.clone(),
                    release_branch: release_branch.clone(),
                    message: message.clone(),
                    file_changes,
                })
                .await?;

            let existing_body =
                bundle.existing_pr.as_ref().map(|pr| pr.body.as_str());

            let request = CreatePrRequest {
                base_branch: self.config.base_branch.clone(),
                head_branch: release_branch.clone(),
                title: message,
                body: self.release_pr_body_for_pr_package_list(
                    &bundle.packages,
                    existing_body,
                )?,
            };

            pr_results.push(PrBranchResult {
                request,
                existing_pr: bundle.existing_pr,
            });
        }

        Ok(pr_results)
    }

    ////////////////////////////////////////////////////////////////////////////
    //// Private
    ////////////////////////////////////////////////////////////////////////////
    fn release_message_for_pr_package_list(
        &self,
        pr_packages: &[ReleasePRPackage],
    ) -> String {
        let mut message =
            format!("chore({}): release", self.config.base_branch);

        if pr_packages.len() == 1 {
            message = format!(
                "{message} {} {}",
                pr_packages[0].name, pr_packages[0].tag.name
            );
        }

        message
    }

    fn release_pr_body_for_pr_package_list(
        &self,
        pr_packages: &[ReleasePRPackage],
        existing_body: Option<&str>,
    ) -> Result<String> {
        let mut body = String::new();

        for pkg in pr_packages.iter() {
            let start_details = if pr_packages.len() == 1 {
                // auto-open dropdown if there's only one package
                "<details open>"
            } else {
                "<details>"
            };

            let metadata = PRMetadata {
                metadata: PRMetadataFields {
                    sha_compare_link: Some(pkg.sha_compare_link.clone()),
                    tag_compare_link: Some(pkg.tag_compare_link.clone()),
                    ..Default::default()
                },
            };

            let json = serde_json::to_string(&metadata)?;
            let metadata_str = format!(r#"<!--{json}-->"#);

            // in the PR body link to the comparison with sha instead
            // of tag since the tag doesn't exist yet
            let notes = pkg
                .notes
                .replace(&pkg.tag_compare_link, &pkg.sha_compare_link);

            let html_id = normalize_html_id(&pkg.name);

            let (header, footer) = existing_body
                .map(|b| extract_preserved_header_footer(b, &html_id))
                .unwrap_or_default();

            // create the drop down
            let package_body = format!(
                r#"{start_details}
<summary>{}</summary>
<div id="{html_id}-header">{header}</div>
<div id="{html_id}" data-tag="{}">
{metadata_str}

{notes}
</div>
<div id="{html_id}-footer">{footer}</div>
</details>"#,
                pkg.tag.name, pkg.tag.name
            );

            if body.is_empty() {
                body = package_body;
            } else {
                body = format!("{body}\n{package_body}");
            }
        }

        Ok(body)
    }

    /// Generic method for building releasable packages with different output
    /// types. Uses the ReleasablePackageBuilder trait to construct the
    /// appropriate type.
    async fn build_releasable_packages<T: ReleasablePackageBuilder>(
        &self,
        packages: Vec<AnalyzedPackage>,
    ) -> Result<Vec<T>> {
        let mut releasable = vec![];

        for pkg in packages.into_iter() {
            if let Some(release) = pkg.release {
                let pkg_config = self.package_configs.get(&pkg.name)?;

                let manifest_files = UpdateManager::load_manifests_for_package(
                    pkg_config,
                    self.forge.as_ref(),
                    &self.config.base_branch,
                )
                .await?;

                let additional_manifest_files =
                    UpdateManager::load_additional_manifests_for_package(
                        pkg_config,
                        self.forge.as_ref(),
                        &self.config.base_branch,
                    )
                    .await?;

                let mut sub_packages = vec![];

                for sub in pkg_config.sub_packages.iter() {
                    let manifest_files =
                        UpdateManager::load_manifests_for_package(
                            sub,
                            self.forge.as_ref(),
                            &self.config.base_branch,
                        )
                        .await?;

                    sub_packages.push(ReleasableSubPackage {
                        name: sub.name.clone(),
                        release_type: sub.release_type,
                        manifest_files,
                    })
                }

                releasable.push(T::build(
                    pkg.name.clone(),
                    release,
                    pkg_config,
                    manifest_files,
                    additional_manifest_files,
                    sub_packages,
                ));
            }
        }

        Ok(releasable)
    }

    fn related_packages<'a>(
        &self,
        target: &ReleasablePackage,
        target_config: &ResolvedPackage,
        others: &'a [&'a ReleasablePackage],
    ) -> Result<Vec<&'a &'a ReleasablePackage>> {
        let mut workspace_packages = vec![];

        for p in others.iter() {
            let p_config = self.package_configs.get(&p.name)?;
            if p.name != target.name
                && p_config.normalized_workspace_root
                    == target_config.normalized_workspace_root
                && p_config.release_type == target_config.release_type
            {
                workspace_packages.push(p);
            }
        }

        Ok(workspace_packages)
    }

    fn changelog_file_change(
        &self,
        target: &ReleasablePackage,
        target_config: &ResolvedPackage,
    ) -> FileChange {
        FileChange {
            path: target_config
                .normalized_full_path
                .join("CHANGELOG.md")
                .to_string_lossy()
                .to_string(),
            content: format!("{}\n\n", target.notes),
            update_type: FileUpdateType::Prepend,
        }
    }
}

#[cfg(test)]
mod tests;