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
|
# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
#
# Modified by Anthony Fok on 2018-10-01 to add support for ppc64el and s390x
#
# Copyright (C) 2015-2017 Canonical Ltd
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""The nodejs plugin is useful for node/npm based parts.
The plugin uses node to install dependencies from `package.json`. It
also sets up binaries defined in `package.json` into the `PATH`.
This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.
Additionally, this plugin uses the following plugin-specific keywords:
- node-packages:
(list)
A list of dependencies to fetch using npm.
- node-engine:
(string)
The version of nodejs you want the snap to run on.
- npm-run:
(list)
A list of targets to `npm run`.
These targets will be run in order, after `npm install`
- npm-flags:
(list)
A list of flags for npm.
- node-package-manager
(string; default: npm)
The language package manager to use to drive installation
of node packages. Can be either `npm` (default) or `yarn`.
"""
import collections
import contextlib
import json
import logging
import os
import shutil
import subprocess
import sys
import snapcraft
from snapcraft import sources
from snapcraft.file_utils import link_or_copy_tree
from snapcraft.internal import errors
logger = logging.getLogger(__name__)
_NODEJS_BASE = "node-v{version}-linux-{arch}"
_NODEJS_VERSION = "12.18.4"
_NODEJS_TMPL = "https://nodejs.org/dist/v{version}/{base}.tar.gz"
_NODEJS_ARCHES = {"i386": "x86", "amd64": "x64", "armhf": "armv7l", "arm64": "arm64", "ppc64el": "ppc64le", "s390x": "s390x"}
_YARN_URL = "https://yarnpkg.com/latest.tar.gz"
class NodePlugin(snapcraft.BasePlugin):
@classmethod
def schema(cls):
schema = super().schema()
schema["properties"]["node-packages"] = {
"type": "array",
"minitems": 1,
"uniqueItems": True,
"items": {"type": "string"},
"default": [],
}
schema["properties"]["node-engine"] = {
"type": "string",
"default": _NODEJS_VERSION,
}
schema["properties"]["node-package-manager"] = {
"type": "string",
"default": "npm",
"enum": ["npm", "yarn"],
}
schema["properties"]["npm-run"] = {
"type": "array",
"minitems": 1,
"uniqueItems": False,
"items": {"type": "string"},
"default": [],
}
schema["properties"]["npm-flags"] = {
"type": "array",
"minitems": 1,
"uniqueItems": False,
"items": {"type": "string"},
"default": [],
}
if "required" in schema:
del schema["required"]
return schema
@classmethod
def get_build_properties(cls):
# Inform Snapcraft of the properties associated with building. If these
# change in the YAML Snapcraft will consider the build step dirty.
return ["node-packages", "npm-run", "npm-flags"]
@classmethod
def get_pull_properties(cls):
# Inform Snapcraft of the properties associated with pulling. If these
# change in the YAML Snapcraft will consider the build step dirty.
return ["node-engine", "node-package-manager"]
@property
def _nodejs_tar(self):
if self._nodejs_tar_handle is None:
self._nodejs_tar_handle = sources.Tar(
self._nodejs_release_uri, self._npm_dir
)
return self._nodejs_tar_handle
@property
def _yarn_tar(self):
if self._yarn_tar_handle is None:
self._yarn_tar_handle = sources.Tar(_YARN_URL, self._npm_dir)
return self._yarn_tar_handle
def __init__(self, name, options, project):
super().__init__(name, options, project)
self._source_package_json = os.path.join(
os.path.abspath(self.options.source), "package.json"
)
self._npm_dir = os.path.join(self.partdir, "npm")
self._manifest = collections.OrderedDict()
self._nodejs_release_uri = get_nodejs_release(
self.options.node_engine, self.project.deb_arch
)
self._nodejs_tar_handle = None
self._yarn_tar_handle = None
def pull(self):
super().pull()
os.makedirs(self._npm_dir, exist_ok=True)
self._nodejs_tar.download()
if self.options.node_package_manager == "yarn":
self._yarn_tar.download()
# do the install in the pull phase to download all dependencies.
if self.options.node_package_manager == "npm":
self._npm_install(rootdir=self.sourcedir)
else:
self._yarn_install(rootdir=self.sourcedir)
def clean_pull(self):
super().clean_pull()
# Remove the npm directory (if any)
if os.path.exists(self._npm_dir):
shutil.rmtree(self._npm_dir)
def build(self):
super().build()
if self.options.node_package_manager == "npm":
installed_node_packages = self._npm_install(rootdir=self.builddir)
# Copy the content of the symlink to the build directory
# LP: #1702661
modules_dir = os.path.join(self.installdir, "lib", "node_modules")
_copy_symlinked_content(modules_dir)
else:
installed_node_packages = self._yarn_install(rootdir=self.builddir)
lock_file_path = os.path.join(self.sourcedir, "yarn.lock")
if os.path.isfile(lock_file_path):
with open(lock_file_path) as lock_file:
self._manifest["yarn-lock-contents"] = lock_file.read()
self._manifest["node-packages"] = [
"{}={}".format(name, installed_node_packages[name])
for name in installed_node_packages
]
def _npm_install(self, rootdir):
self._nodejs_tar.provision(
self.installdir, clean_target=False, keep_tarball=True
)
npm_cmd = ["npm"] + self.options.npm_flags
npm_install = npm_cmd + ["--cache-min=Infinity", "install"]
for pkg in self.options.node_packages:
self.run(npm_install + ["--global"] + [pkg], cwd=rootdir)
if os.path.exists(os.path.join(rootdir, "package.json")):
self.run(npm_install, cwd=rootdir)
self.run(npm_install + ["--global"], cwd=rootdir)
for target in self.options.npm_run:
self.run(npm_cmd + ["run", target], cwd=rootdir)
return self._get_installed_node_packages("npm", self.installdir)
def _yarn_install(self, rootdir):
self._nodejs_tar.provision(
self.installdir, clean_target=False, keep_tarball=True
)
self._yarn_tar.provision(self._npm_dir, clean_target=False, keep_tarball=True)
yarn_cmd = [os.path.join(self._npm_dir, "bin", "yarn")]
yarn_cmd.extend(self.options.npm_flags)
if "http_proxy" in os.environ:
yarn_cmd.extend(["--proxy", os.environ["http_proxy"]])
if "https_proxy" in os.environ:
yarn_cmd.extend(["--https-proxy", os.environ["https_proxy"]])
flags = []
if rootdir == self.builddir:
yarn_add = yarn_cmd + ["global", "add"]
flags.extend(
[
"--offline",
"--prod",
"--global-folder",
self.installdir,
"--prefix",
self.installdir,
]
)
else:
yarn_add = yarn_cmd + ["add"]
for pkg in self.options.node_packages:
self.run(yarn_add + [pkg] + flags, cwd=rootdir)
# local packages need to be added as if they were remote, we
# remove the local package.json so `yarn add` doesn't pollute it.
if os.path.exists(self._source_package_json):
with contextlib.suppress(FileNotFoundError):
os.unlink(os
|