-
Notifications
You must be signed in to change notification settings - Fork 1
/
types.go
232 lines (192 loc) · 6.53 KB
/
types.go
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
// SPDX-License-Identifier: Apache-2.0
//
// Copyright © 2023 The listen.dev team <engineering@garnet.ai>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package npm
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"strings"
"github.com/Masterminds/semver/v3"
npmdeptype "github.com/listendev/lstn/pkg/npm/deptype"
"github.com/listendev/lstn/pkg/validate"
)
type packageJSON struct {
Dependencies map[string]string `json:"dependencies"`
DevDependencies map[string]string `json:"devDependencies"`
PeerDependencies map[string]string `json:"peerDependencies"`
BundleDependencies []string `json:"bundleDependencies"`
OptionalDependencies map[string]string `json:"optionalDependencies"`
}
type PackageJSON interface {
FilterOutByTypes(...npmdeptype.Enum)
FilterOutByNames(...string)
Deps(context.Context, VersionResolutionStrategy) map[npmdeptype.Enum]map[string]*semver.Version
}
// The VersionResolutionStrategy is a function that, given a version constraints,
// returns back an exact version.
type VersionResolutionStrategy func(semver.Collection) *semver.Version
type LockfileVersion struct {
Value int `json:"lockfileVersion" name:"lockfile version" validate:"gte=1,lte=3"`
}
type packageLockJSONVersion1 struct {
Name string `json:"name"`
Version string `json:"version"`
Dependencies map[string]PackageLockDependency `json:"dependencies"`
}
type packageLockJSONVersion2 struct {
Name string `json:"name"`
Version string `json:"version"`
Dependencies map[string]PackageLockDependency `json:"dependencies"`
}
type packageLockJSONVersion3 struct {
Name string `json:"name"`
Version string `json:"version"`
Dependencies map[string]PackageLockDependency `json:"packages"`
}
type packageLockJSON struct {
LockfileVersion
*packageLockJSONVersion1
*packageLockJSONVersion2
*packageLockJSONVersion3
bytes []byte
}
func (p *packageLockJSON) UnmarshalJSON(data []byte) error {
if err := json.Unmarshal(data, &p.LockfileVersion); err != nil {
return err
}
switch p.LockfileVersion.Value {
case 1:
p.packageLockJSONVersion1 = &packageLockJSONVersion1{}
return json.Unmarshal(data, p.packageLockJSONVersion1)
case 2:
p.packageLockJSONVersion2 = &packageLockJSONVersion2{}
return json.Unmarshal(data, p.packageLockJSONVersion2)
case 3:
p.packageLockJSONVersion3 = &packageLockJSONVersion3{}
if err := json.Unmarshal(data, p.packageLockJSONVersion3); err != nil {
return err
}
for k := range p.packageLockJSONVersion3.Dependencies {
if k == "" {
delete(p.packageLockJSONVersion3.Dependencies, k)
}
if strings.HasPrefix(k, "node_modules") {
newk := strings.TrimPrefix(k, "node_modules/")
p.packageLockJSONVersion3.Dependencies[newk] = p.packageLockJSONVersion3.Dependencies[k]
delete(p.packageLockJSONVersion3.Dependencies, k)
}
}
return nil
default:
return fmt.Errorf("unsupported package-lock.json version")
}
}
type PackageLockJSON interface {
Deps() map[string]PackageLockDependency
Encode() string
Ok() bool
Version() int
}
type PackageLockDependency struct {
Version string `json:"version"`
Resolved string `json:"resolved"`
}
type Package struct {
Version string `json:"version" name:"version" validate:"semver"`
Shasum string `json:"shasum" name:"shasum" validate:"shasum"`
}
func (p *Package) Ok() bool {
return validate.Singleton.Struct(p) == nil
}
type Packages map[string]Package
func (p Packages) Ok() bool {
if len(p) == 0 {
return false
}
for name, pack := range p {
if validate.Singleton.Var(name, "npm_package_name") != nil {
return false
}
if !pack.Ok() {
return false
}
}
return true
}
// NewPackageLockJSON is a factory to create an empty (and invalid) PackageLockJSON.
func NewPackageLockJSON() PackageLockJSON {
ret := &packageLockJSON{}
return ret
}
func (p *packageLockJSON) Version() int {
return p.LockfileVersion.Value
}
func (p *packageLockJSON) Ok() bool {
err := validate.Singleton.Struct(p)
return err == nil
}
// NewPackageLockJSONFromDir creates a PackageLockJSON instance from the package.json in the dir directory (if any).
func NewPackageLockJSONFromDir(ctx context.Context, dir string) (PackageLockJSON, error) {
JSON, err := generatePackageLock(ctx, dir)
if err != nil {
return nil, err
}
return NewPackageLockJSONFromBytes(JSON)
}
// NewPackageLockJSONFromReader creates a PackageLockJSON instance from by reading the contents of a package-lock.json file.
func NewPackageLockJSONFromReader(reader io.Reader) (PackageLockJSON, error) {
ret := &packageLockJSON{}
var b bytes.Buffer
r := io.TeeReader(reader, &b)
if err := json.NewDecoder(r).Decode(ret); err != nil {
return nil, fmt.Errorf("couldn't instantiate from the input package-lock.json contents")
}
ret.bytes = b.Bytes()
return ret, nil
}
func NewPackageLockJSONFromBytes(b []byte) (PackageLockJSON, error) {
ret := &packageLockJSON{}
if err := json.Unmarshal(b, ret); err != nil {
return nil, fmt.Errorf("couldn't instantiate from the input package-lock.json contents")
}
ret.bytes = b
return ret, nil
}
// GetPackageLockJSONFromDir creates a PackageLockJSON instance from the existing package-lock.json in dir, if any.
func GetPackageLockJSONFromDir(dir string) (PackageLockJSON, error) {
reader, err := read(dir, "package-lock.json")
if err != nil {
return nil, err
}
return NewPackageLockJSONFromReader(reader)
}
// GetPackageJSONFromDir creates a PackageJSON instance from the existing package.json in dir, if any.
func GetPackageJSONFromDir(dir string) (PackageJSON, error) {
reader, err := read(dir, "package.json")
if err != nil {
return nil, err
}
return NewPackageJSONFromReader(reader)
}
func NewPackageJSONFromReader(reader io.Reader) (PackageJSON, error) {
ret := &packageJSON{}
if err := json.NewDecoder(reader).Decode(ret); err != nil {
return nil, fmt.Errorf("couldn't instantiate from the input package.json contents")
}
return ret, nil
}