git commit message with reserved word cannot build in GitLab CI

Describe the bug

OK here’s a weirdo one. I build my project using yarn build (vite build) in GitLab CI, then rsync the compiled bundle/code to my server that’s running a simple node server (i.e. I’m using adapter-node), and then GitLab CI then restarts the service on the remote.

I am actually writing this because I’ve updated Kit to the very latest today, and I had to re-work how I was using environment variables (I shifted from import.meta.env to $env/static/public and $env/static/private).

My commit message was then something like “refactor to remove import.meta.env” – but GitLab puts certain environment variables in the build environment, such as CI_COMMIT_TITLE. Kit then tries to pull them all in to the static build, but as it contains the word “import,” it is rejected, and my build soft fails.

I think that this is happening in kit/src/core/env.js (that’s where I found references to this being a reserved word).

Looking up at utils.js/get_env, it doesn’t seem there’s a way to ignore/exclude certain variables from the build. (This would work for me as all GitLab’s variables start with CI_ and I could filter those out.)

After I did another commit message without a reserved word, all was fine with the build.

Using

• @sveltejs/kit 1.0.0-next.427
• vite 3.0.9

Reproduction

https://stackblitz.com/edit/sveltejs-kit-template-default-gvupwf?file=src/routes/+page.svelte

Once in the stackblitz, stop the development server and issue:

CI_COMMIT_TITLE="do not use import.meta.env" npm run build

And the error happens.

Logs

====== GitLab Runner output ========

Running with gitlab-runner 14.8.1 (6a42249e)
  on poppie 0cc5fdb6
section_start:1660937353:prepare_executor
Preparing the "docker" executor
Using Docker executor with image jerry.redfinsolutions.com:4567/redfin/d9-rfs:latest ...
Authenticating with credentials from $DOCKER_AUTH_CONFIG
Pulling docker image jerry.redfinsolutions.com:4567/redfin/d9-rfs:latest ...
WARNING: Failed to pull image with policy "always": Error response from daemon: Get https://jerry.redfinsolutions.com:4567/v2/redfin/d9-rfs/manifests/latest: unauthorized: HTTP Basic: Access denied (manager.go:203:0s)
Attempt #2: Trying "if-not-present" pull policy
Using locally found image version due to "if-not-present" pull policy
Using docker image sha256:803a92719e02fc5d441f574f31393b7152504b987da5b7e3b981ecde302cecff for jerry.redfinsolutions.com:4567/redfin/d9-rfs:latest with digest jerry.redfinsolutions.com:4567/redfin/d9-rfs@sha256:d6bebd812789a2d31a6d6a8bed1086e63d40a4180540acd5ba4fa25e5ea1d61d ...
section_end:1660937354:prepare_executor
section_start:1660937354:prepare_script
Preparing environment
Running on joey via poppie.redfinsolutions.com...
section_end:1660937355:prepare_script
section_start:1660937355:get_sources
Getting source from Git repository
Fetching changes with git depth set to 50...
Reinitialized existing Git repository in /ebsvol/gitlab-runner/builds_dir/redfin/silo/.git/
Checking out 3d82dfd6 as main...
Removing frontend/.svelte-kit/
Removing frontend/node_modules/
Removing vendor/

Skipping Git submodules setup
section_end:1660937357:get_sources
section_start:1660937357:restore_cache
Restoring cache
Checking cache for main-protected...
No URL provided, cache will not be downloaded from shared cache server. Instead a local version of cache will be extracted. 
Successfully extracted cache
section_end:1660937358:restore_cache
section_start:1660937358:step_script
Executing "step_script" stage of the job script
Using docker image sha256:803a92719e02fc5d441f574f31393b7152504b987da5b7e3b981ecde302cecff for jerry.redfinsolutions.com:4567/redfin/d9-rfs:latest with digest jerry.redfinsolutions.com:4567/redfin/d9-rfs@sha256:d6bebd812789a2d31a6d6a8bed1086e63d40a4180540acd5ba4fa25e5ea1d61d ...
$ which ssh-agent || ( apt-get update -y && apt-get install openssh-client -y )
/usr/bin/ssh-agent
$ eval $(ssh-agent -s)
Agent pid 12
$ echo "$SSH_PRIVATE_KEY" | tr -d '\r' | ssh-add - > /dev/null
Identity added: (stdin) ((stdin))
$ mkdir -p ~/.ssh
$ chmod 700 ~/.ssh
$ echo "$SSH_KNOWN_HOSTS" > ~/.ssh/known_hosts
$ chmod 644 ~/.ssh/known_hosts
$ composer install --no-dev -o --no-interaction
Installing dependencies from lock file
Verifying lock file contents can be installed on current platform.
Warning: The lock file is not up to date with the latest changes in composer.json. You may be getting outdated dependencies. It is recommended that you run `composer update` or `composer update <package name>`.
Nothing to install, update or remove
Generating optimized autoload files
46 packages you are using are looking for funding.
Use the `composer fund` command to find out more!
$ source /root/.nvm/nvm.sh && nvm install 16 && nvm use 16 && cd frontend && yarn install && yarn run build && cd ..
Downloading and installing node v16.17.0...
Downloading https://nodejs.org/dist/v16.17.0/node-v16.17.0-linux-x64.tar.xz...
#=#=#                                                                         

###########                                                               15.3%
##########################################                                59.2%
#######################################################################   99.5%
######################################################################## 100.0%
Computing checksum with sha256sum
Checksums matched!
Now using node v16.17.0 (npm v8.15.0)
Now using node v16.17.0 (npm v8.15.0)
yarn install v1.22.17
[1/4] Resolving packages...
[2/4] Fetching packages...
[3/4] Linking dependencies...
[4/4] Building fresh packages...
Done in 12.01s.
yarn run v1.22.17
$ vite build
vite v3.0.9 building for production...
transforming...
✓ 133 modules transformed.
rendering chunks...
.svelte-kit/output/client/_app/immutable/assets/logo-fb233249.svg                                           1.42 KiB
.svelte-kit/output/client/_app/immutable/assets/rblogo-122a3233.svg                                         1.12 KiB
.svelte-kit/output/client/_app/immutable/assets/hive-logo-ad4fa3ca.svg                                      1.07 KiB
.svelte-kit/output/client/_app/immutable/assets/taiga-d32ca588.svg                                          1.12 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-cyrillic-ext-400-normal-df8fd002.woff2            17.06 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-greek-400-normal-716e9e0f.woff2                   8.67 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-hebrew-400-normal-aaa9af21.woff2                  7.38 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-vietnamese-400-normal-4029d256.woff2              6.97 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-latin-ext-400-normal-e3d26484.woff2               12.65 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-latin-400-normal-9434dddc.woff2                   16.33 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-cyrillic-ext-600-normal-61607f75.woff2            17.11 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-cyrillic-600-normal-c50e9125.woff2                9.82 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-greek-600-normal-c14d48a7.woff2                   8.76 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-hebrew-600-normal-376b2f33.woff2                  7.41 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-vietnamese-600-normal-e3a2965e.woff2              7.02 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-latin-ext-600-normal-efe80523.woff2               12.67 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-latin-600-normal-511b67b0.woff2                   16.40 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-cyrillic-ext-700-normal-7d9bdb20.woff2            16.54 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-cyrillic-700-normal-23f56ffb.woff2                9.64 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-greek-700-normal-27b24d98.woff2                   8.61 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-hebrew-700-normal-2b0539af.woff2                  7.37 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-vietnamese-700-normal-2bb39cab.woff2              6.89 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-latin-ext-700-normal-9754e1f0.woff2               12.40 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-latin-700-normal-e3f25c51.woff2                   15.98 KiB
.svelte-kit/output/client/_app/immutable/assets/montserrat-cyrillic-ext-700-normal-f1b35279.woff2           8.82 KiB
.svelte-kit/output/client/_app/immutable/assets/montserrat-cyrillic-700-normal-06bbd095.woff2               7.97 KiB
.svelte-kit/output/client/_app/immutable/assets/montserrat-latin-ext-700-normal-cc7345cd.woff2              10.32 KiB
.svelte-kit/output/client/_app/immutable/assets/montserrat-latin-700-normal-f31b8056.woff2                  12.55 KiB
.svelte-kit/output/client/_app/immutable/assets/montserrat-cyrillic-ext-400-normal-68ce5e02.woff2           8.68 KiB
.svelte-kit/output/client/_app/immutable/assets/montserrat-cyrillic-400-normal-7849168d.woff2               7.82 KiB
.svelte-kit/output/client/_app/immutable/assets/montserrat-latin-ext-400-normal-a663bd98.woff2              10.04 KiB
.svelte-kit/output/client/_app/immutable/assets/montserrat-latin-400-normal-ddc148b8.woff2                  12.41 KiB
.svelte-kit/output/client/_app/immutable/assets/inconsolata-vietnamese-400-normal-23c5437a.woff2            6.68 KiB
.svelte-kit/output/client/_app/immutable/assets/inconsolata-latin-ext-400-normal-f8986368.woff2             14.43 KiB
.svelte-kit/output/client/_app/immutable/assets/inconsolata-latin-400-normal-4f9f98d7.woff2                 15.86 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-cyrillic-400-normal-7f96afbe.woff2                9.85 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-all-400-normal-82a8e0e7.woff                      69.20 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-all-600-normal-dfa7e587.woff                      69.06 KiB
.svelte-kit/output/client/_app/immutable/assets/open-sans-all-700-normal-ca8f4dbd.woff                      67.12 KiB
.svelte-kit/output/client/_app/immutable/assets/montserrat-all-700-normal-46a8b2d4.woff                     49.95 KiB
.svelte-kit/output/client/_app/immutable/assets/montserrat-all-400-normal-805f620f.woff                     49.58 KiB
.svelte-kit/output/client/_app/immutable/assets/inconsolata-all-400-normal-04adc109.woff                    44.47 KiB
.svelte-kit/output/client/vite-manifest.json                                                                29.43 KiB
.svelte-kit/output/client/_app/immutable/components/pages/debug/env/_page.svelte-04cb9698.js                1.47 KiB / gzip: 0.77 KiB
.svelte-kit/output/client/_app/immutable/components/pages/my/hours/_page.svelte-0d8eff93.js                 2.45 KiB / gzip: 1.14 KiB
.svelte-kit/output/client/_app/immutable/components/pages/_page.svelte-107c9b79.js                          15.72 KiB / gzip: 5.79 KiB
.svelte-kit/output/client/_app/immutable/components/pages/my/tasks/_page.svelte-cd184459.js                 2.07 KiB / gzip: 0.98 KiB
.svelte-kit/output/client/_app/immutable/components/pages/ops/sync/_page.svelte-1f2b876c.js                 6.04 KiB / gzip: 2.25 KiB
.svelte-kit/output/client/_app/immutable/components/pages/pm/priorities/_page.svelte-e0d7cedb.js            14.62 KiB / gzip: 5.35 KiB
.svelte-kit/output/client/_app/immutable/components/pages/pm/resource-allocation/_page.svelte-bb88dd61.js   3.58 KiB / gzip: 1.65 KiB
.svelte-kit/output/client/_app/immutable/components/pages/pm/task-aging/_page.svelte-25184320.js            4.59 KiB / gzip: 2.02 KiB
.svelte-kit/output/client/_app/immutable/components/error.svelte-ba40ce30.js                                1.54 KiB / gzip: 0.71 KiB
.svelte-kit/output/client/_app/immutable/components/pages/sync-schedule/_page.svelte-ef10a2e3.js            3.55 KiB / gzip: 1.23 KiB
.svelte-kit/output/client/_app/immutable/modules/pages/sec/updates/_page.js-adaa7194.js                     0.11 KiB / gzip: 0.10 KiB
.svelte-kit/output/client/_app/immutable/chunks/singletons-e5e57fbd.js                                      0.05 KiB / gzip: 0.07 KiB
.svelte-kit/output/client/_app/immutable/chunks/index-d6fabef0.js                                           0.43 KiB / gzip: 0.28 KiB
.svelte-kit/output/client/_app/immutable/chunks/stores-6417e525.js                                          0.53 KiB / gzip: 0.31 KiB
.svelte-kit/output/client/_app/immutable/chunks/public-de53b5a8.js                                          0.28 KiB / gzip: 0.25 KiB
.svelte-kit/output/client/_app/immutable/chunks/index-b0f516b1.js                                           16.42 KiB / gzip: 6.82 KiB
.svelte-kit/output/client/_app/immutable/chunks/index-fb4c3a07.js                                           0.14 KiB / gzip: 0.14 KiB
.svelte-kit/output/client/_app/immutable/chunks/index-4d0712f3.js                                           0.79 KiB / gzip: 0.37 KiB
.svelte-kit/output/client/_app/immutable/chunks/_helpers-c0b00fab.js                                        2.05 KiB / gzip: 0.99 KiB
.svelte-kit/output/client/_app/immutable/chunks/dayjs.min-244924c2.js                                       6.35 KiB / gzip: 2.86 KiB
.svelte-kit/output/client/_app/immutable/components/pages/_layout.svelte-3f37f4a9.js                        23.82 KiB / gzip: 13.38 KiB
.svelte-kit/output/client/_app/immutable/chunks/RedfinSpinner-fbf1779b.js                                   1.87 KiB / gzip: 0.95 KiB
.svelte-kit/output/client/_app/immutable/chunks/isSameOrBefore-4c3ce22f.js                                  0.27 KiB / gzip: 0.19 KiB
.svelte-kit/output/client/_app/immutable/chunks/UserHoursTable-60ce13da.js                                  7.96 KiB / gzip: 2.88 KiB
.svelte-kit/output/client/_app/immutable/chunks/_commonjsHelpers-094ef602.js                                0.13 KiB / gzip: 0.09 KiB
.svelte-kit/output/client/_app/immutable/chunks/TaskLink-0e886d2e.js                                        2.52 KiB / gzip: 1.17 KiB
.svelte-kit/output/client/_app/immutable/chunks/_page-dbced1cf.js                                           0.31 KiB / gzip: 0.25 KiB
.svelte-kit/output/client/_app/immutable/chunks/0-d128067e.js                                               0.32 KiB / gzip: 0.21 KiB
.svelte-kit/output/client/_app/immutable/chunks/2-16475788.js                                               0.48 KiB / gzip: 0.28 KiB
.svelte-kit/output/client/_app/immutable/chunks/3-830a9202.js                                               0.16 KiB / gzip: 0.14 KiB
.svelte-kit/output/client/_app/immutable/components/pages/my/status/_page.svelte-ce76e27d.js                29.69 KiB / gzip: 10.67 KiB
.svelte-kit/output/client/_app/immutable/chunks/4-f5d745dd.js                                               0.30 KiB / gzip: 0.21 KiB
.svelte-kit/output/client/_app/immutable/chunks/5-4104c238.js                                               0.33 KiB / gzip: 0.22 KiB
.svelte-kit/output/client/_app/immutable/chunks/6-4150cb74.js                                               0.29 KiB / gzip: 0.21 KiB
.svelte-kit/output/client/_app/immutable/chunks/7-32a61f7b.js                                               0.16 KiB / gzip: 0.15 KiB
.svelte-kit/output/client/_app/immutable/chunks/9-d30f8499.js                                               0.35 KiB / gzip: 0.23 KiB
.svelte-kit/output/client/_app/immutable/chunks/10-bef4f1d1.js                                              0.20 KiB / gzip: 0.16 KiB
.svelte-kit/output/client/_app/immutable/chunks/11-800355c0.js                                              0.33 KiB / gzip: 0.20 KiB
.svelte-kit/output/client/_app/immutable/chunks/12-85c60980.js                                              0.13 KiB / gzip: 0.13 KiB
.svelte-kit/output/client/_app/immutable/assets/RedfinSpinner-5cc81953.css                                  0.29 KiB / gzip: 0.17 KiB
.svelte-kit/output/client/_app/immutable/assets/+page-14455fa0.css                                          1.00 KiB / gzip: 0.44 KiB
.svelte-kit/output/client/_app/immutable/chunks/UserSelect-51ce3f2c.js                                      43.14 KiB / gzip: 14.95 KiB
.svelte-kit/output/client/_app/immutable/assets/UserHoursTable-ad021614.css                                 2.17 KiB / gzip: 0.57 KiB
.svelte-kit/output/client/_app/immutable/assets/+page-b820ac6d.css                                          0.24 KiB / gzip: 0.17 KiB
.svelte-kit/output/client/_app/immutable/assets/+page-44557bde.css                                          0.61 KiB / gzip: 0.24 KiB
.svelte-kit/output/client/_app/immutable/chunks/8-548f7bb1.js                                               0.32 KiB / gzip: 0.21 KiB
.svelte-kit/output/client/_app/immutable/assets/TaskLink-1269a512.css                                       0.12 KiB / gzip: 0.11 KiB
.svelte-kit/output/client/_app/immutable/assets/+page-8a841b44.css                                          4.02 KiB / gzip: 0.95 KiB
.svelte-kit/output/client/_app/immutable/assets/+page-d788d599.css                                          0.19 KiB / gzip: 0.13 KiB
.svelte-kit/output/client/_app/immutable/assets/+page-8fea6c98.css                                          0.17 KiB / gzip: 0.10 KiB
.svelte-kit/output/client/_app/immutable/assets/UserSelect-cc329166.css                                     9.06 KiB / gzip: 2.41 KiB
.svelte-kit/output/client/_app/immutable/assets/+page-3797a5bf.css                                          0.04 KiB / gzip: 0.06 KiB
.svelte-kit/output/client/_app/immutable/assets/+page-ce2a175c.css                                          0.07 KiB / gzip: 0.09 KiB
.svelte-kit/output/client/_app/immutable/start-2eadef4b.js                                                  26.72 KiB / gzip: 9.46 KiB
.svelte-kit/output/client/_app/immutable/chunks/GitlabMRsTable-19026bde.js                                  8.19 KiB / gzip: 3.00 KiB
.svelte-kit/output/client/_app/immutable/components/pages/sec/updates/_page.svelte-4a8f58e8.js              43.37 KiB / gzip: 14.56 KiB
.svelte-kit/output/client/_app/immutable/chunks/1-22492f41.js                                               0.14 KiB / gzip: 0.13 KiB
.svelte-kit/output/client/_app/immutable/assets/+layout-39835336.css                                        39.17 KiB / gzip: 20.44 KiB
vite v3.0.9 building SSR bundle for production...
transforming...
✓ 60 modules transformed.
Unexpected token (Note that you need plugins to import files that are not JavaScript)
file: �$env/static/private:351:54
349: 
350: /** @type {import('$env/static/private').CI_COMMIT_TITLE} */
351: export const CI_COMMIT_TITLE = "will not build with import.meta.env";
                                                           ^
352: 
353: /** @type {import('$env/static/private').CI_PROJECT_TITLE} */
[vite-plugin-svelte-kit] Unexpected token (Note that you need plugins to import files that are not JavaScript)
file: �$env/static/private:351:54
349: 
350: /** @type {import('$env/static/private').CI_COMMIT_TITLE} */
351: export const CI_COMMIT_TITLE = "will not build with import.meta.env";
                                                           ^
352: 
353: /** @type {import('$env/static/private').CI_PROJECT_TITLE} */
error during build:
Error: Unexpected token (Note that you need plugins to import files that are not JavaScript)
    at error (file:///ebsvol/gitlab-runner/builds_dir/redfin/silo/frontend/node_modules/rollup/dist/es/shared/rollup.js:1858:30)
    at Module.error (file:///ebsvol/gitlab-runner/builds_dir/redfin/silo/frontend/node_modules/rollup/dist/es/shared/rollup.js:12412:16)
    at Module.tryParse (file:///ebsvol/gitlab-runner/builds_dir/redfin/silo/frontend/node_modules/rollup/dist/es/shared/rollup.js:12789:25)
    at Module.setSource (file:///ebsvol/gitlab-runner/builds_dir/redfin/silo/frontend/node_modules/rollup/dist/es/shared/rollup.js:12694:24)
    at ModuleLoader.addModuleSource (file:///ebsvol/gitlab-runner/builds_dir/redfin/silo/frontend/node_modules/rollup/dist/es/shared/rollup.js:22136:20)
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
$ rsync -avz --no-perms --no-owner --no-group --exclude-from=".exclude" --delete-after -e 'ssh -p 22' . [e-mail]:src/silo-cli
rsync: failed to open exclude file .exclude: No such file or directory (2)
rsync error: error in file IO (code 11) at exclude.c(1178) [client=3.1.2]
section_end:1660937387:step_script
section_start:1660937387:cleanup_file_variables
Cleaning up project directory and file based variables
section_end:1660937388:cleanup_file_variables
ERROR: Job failed: exit code 1


System Info

System:
    OS: macOS 12.4
    CPU: (8) arm64 Apple M1 Pro
    Memory: 73.84 MB / 32.00 GB
    Shell: 5.8.1 - /bin/zsh
  Binaries:
    Node: 16.13.0 - ~/.nvm/versions/node/v16.13.0/bin/node
    Yarn: 1.22.19 - /opt/homebrew/bin/yarn
    npm: 8.1.0 - ~/.nvm/versions/node/v16.13.0/bin/npm
    Watchman: 2022.06.06.00 - /opt/homebrew/bin/watchman
  Browsers:
    Brave Browser: 104.1.42.95
    Chrome: 104.0.5112.101
    Firefox Developer Edition: 104.0
    Safari: 15.5
  npmPackages:
    @sveltejs/adapter-auto: ^1.0.0-next.50 => 1.0.0-next.64
    @sveltejs/adapter-node: ^1.0.0-next.67 => 1.0.0-next.86
    @sveltejs/kit: ^1.0.0-next.260 => 1.0.0-next.424
    svelte: ^3.44.0 => 3.49.0
    vite: ^3.0.9 => 3.0.9

Severity

annoyance

Additional Information

I think the proper thing would be to write in a way to exclude certain variables or a certain RegEx of variables as “do not build these into env/static”

I think this would happen maybe in get_env:

/**
 * Load environment variables from process.env and .env files
 * @param {string} mode
 * @param {string} prefix
 */
export function get_env(mode, prefix) {
	const entries = Object.entries(loadEnv(mode, process.cwd(), ''));

	return {
		public: Object.fromEntries(entries.filter(([k]) => k.startsWith(prefix))),
		private: Object.fromEntries(entries.filter(([k]) => !k.startsWith(prefix)))
	};
}

…with perhaps an additional entries.filter??

[tcc-sejohnson]

Oh my gosh, I usually feel bad when features I implement introduce a bug, but honestly, even on my absolute best day ever, I would never have seen this one coming.

[chrisfromredfin]

PR already open upstream! https://github.com/vitejs/vite/pull/9791