deno_lockfile 0.45.0

An implementation of a lockfile used in Deno
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

// Copyright 2018-2026 the Deno authors. MIT license.

use std::collections::HashSet;
use std::path::PathBuf;

use deno_lockfile::Lockfile;
use deno_lockfile::SetWorkspaceConfigOptions;
use deno_lockfile::WorkspaceConfig;
use deno_lockfile::WorkspaceMemberConfig;
use deno_semver::jsr::JsrDepPackageReq;

#[test]
fn adding_workspace_does_not_cause_content_changes() {
  // should maintain the has_content_changed flag when lockfile empty
  {
    let mut lockfile = Lockfile::new_empty(PathBuf::from("./deno.lock"), true);

    assert!(!lockfile.has_content_changed);
    lockfile.set_workspace_config(SetWorkspaceConfigOptions {
      no_config: false,
      no_npm: false,
      config: WorkspaceConfig {
        root: WorkspaceMemberConfig {
          dependencies: HashSet::from([JsrDepPackageReq::from_str(
            "jsr:@scope/package",
          )
          .unwrap()]),
          package_json_deps: Default::default(),
        },
        members: Default::default(),
        links: Default::default(),
        npm_overrides: None,
      },
    });
    assert!(!lockfile.has_content_changed); // should not have changed
  }

  // should maintain has_content_changed flag when true and lockfile is empty
  {
    let mut lockfile = Lockfile::new_empty(PathBuf::from("./deno.lock"), true);
    lockfile.has_content_changed = true;
    lockfile.set_workspace_config(SetWorkspaceConfigOptions {
      no_config: false,
      no_npm: false,
      config: WorkspaceConfig {
        root: WorkspaceMemberConfig {
          dependencies: HashSet::from([JsrDepPackageReq::from_str(
            "jsr:@scope/package2",
          )
          .unwrap()]),
          package_json_deps: Default::default(),
        },
        members: Default::default(),
        links: Default::default(),
        npm_overrides: None,
      },
    });
    assert!(lockfile.has_content_changed);
  }

  // should not maintain the has_content_changed flag when lockfile is not empty
  {
    let mut lockfile = Lockfile::new_empty(PathBuf::from("./deno.lock"), true);
    lockfile
      .content
      .redirects
      .insert("a".to_string(), "b".to_string());

    assert!(!lockfile.has_content_changed);
    lockfile.set_workspace_config(SetWorkspaceConfigOptions {
      no_config: false,
      no_npm: false,
      config: WorkspaceConfig {
        root: WorkspaceMemberConfig {
          dependencies: HashSet::from([JsrDepPackageReq::from_str(
            "jsr:@scope/package",
          )
          .unwrap()]),
          package_json_deps: Default::default(),
        },
        members: Default::default(),
        links: Default::default(),
        npm_overrides: None,
      },
    });
    assert!(lockfile.has_content_changed); // should have changed since lockfile was not empty
  }
}

#[test]
fn npm_overrides_causes_content_change() {
  // setting npm_overrides should cause content change when lockfile not empty
  let mut lockfile = Lockfile::new_empty(PathBuf::from("./deno.lock"), true);
  lockfile
    .content
    .redirects
    .insert("a".to_string(), "b".to_string());

  assert!(!lockfile.has_content_changed);
  lockfile.set_workspace_config(SetWorkspaceConfigOptions {
    no_config: false,
    no_npm: false,
    config: WorkspaceConfig {
      root: Default::default(),
      members: Default::default(),
      links: Default::default(),
      npm_overrides: Some(serde_json::json!({
        "foo": "1.0.0"
      })),
    },
  });
  assert!(lockfile.has_content_changed);
}

#[test]
fn npm_overrides_serialized_in_package_json_section() {
  let mut lockfile = Lockfile::new_empty(PathBuf::from("./deno.lock"), true);
  lockfile.set_workspace_config(SetWorkspaceConfigOptions {
    no_config: false,
    no_npm: false,
    config: WorkspaceConfig {
      root: WorkspaceMemberConfig {
        dependencies: Default::default(),
        package_json_deps: HashSet::from([JsrDepPackageReq::from_str(
          "npm:foo@1.0.0",
        )
        .unwrap()]),
      },
      members: Default::default(),
      links: Default::default(),
      npm_overrides: Some(serde_json::json!({
        "bar": "2.0.0"
      })),
    },
  });

  // force content changed so we can serialize
  lockfile.has_content_changed = true;

  let output = lockfile.as_json_string();
  let parsed: serde_json::Value = serde_json::from_str(&output).unwrap();

  // verify overrides is in workspace.packageJson, not workspace directly
  assert!(
    parsed
      .get("workspace")
      .and_then(|w| w.get("packageJson"))
      .and_then(|pj| pj.get("overrides"))
      .is_some(),
    "overrides should be in workspace.packageJson section"
  );
  assert!(
    parsed
      .get("workspace")
      .and_then(|w| w.get("overrides"))
      .is_none(),
    "overrides should not be at workspace level"
  );

  // verify the actual value
  let overrides = parsed
    .get("workspace")
    .and_then(|w| w.get("packageJson"))
    .and_then(|pj| pj.get("overrides"))
    .unwrap();
  assert_eq!(overrides, &serde_json::json!({"bar": "2.0.0"}));
}