Skip to content

Enable work with scoped names of GitLab npm registry #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
IgorPomelnikov wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Enable work with scoped names of GitLab npm registry #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad330ab
Enable work with GitLab registry by adding --GITLAB_REGISTRY.
Aug 1, 2024
93f6706
Update README.md
IgorPomelnikov Aug 1, 2024
02ca547
Update README.md
IgorPomelnikov Aug 1, 2024
e1fc918
Add the ability to override the cache-control header.
Aug 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,19 @@ node node_modules/unpkg-server/server.js \

These values can be set on the system environment when starting the unpkg `server.js`.

| Flag | Options / Description | Default value |
| ---------------------- | ------------------------------------------------ | ---------------------------- |
| `NPM_REGISTRY_URL` | optional - private registry url | `https://registry.npmjs.org` |
| `PORT` | optional - port to listen on | `8080` |
| `GOOGLE_CLOUD_PROJECT` | The GCP project ID. | `null` |
| `GAE_ENV` | `standard` to enable `@google-cloud/trace-agent` | `null` |
| `DEBUG` | enableDebugging | `false` |
| `ENABLE_CLOUDFLARE` | optional `true` or `false` | `false` |
| `ORIGIN` | optional | `https://unpkg.com` |
| `CLOUDFLARE_EMAIL` | optional | `null` |
| `CLOUDFLARE_KEY` | optional | `null` |
| Flag | Options / Description | Default value |
| ---------------------- | ------------------------------------------------------ | ---------------------------- |
| `NPM_REGISTRY_URL` | optional - private registry url | `https://registry.npmjs.org` |
| `PORT` | optional - port to listen on | `8080` |
| `GOOGLE_CLOUD_PROJECT` | The GCP project ID. | `null` |
| `GAE_ENV` | `standard` to enable `@google-cloud/trace-agent` | `null` |
| `DEBUG` | enableDebugging | `false` |
| `ENABLE_CLOUDFLARE` | optional `true` or `false` | `false` |
| `ORIGIN` | optional | `https://unpkg.com` |
| `CLOUDFLARE_EMAIL` | optional | `null` |
| `CLOUDFLARE_KEY` | optional | `null` |
| `GITLAB_REGISTRY` | optional - enable work with GitLab npm scoped packages | `null` |
| `CACHE_CONTROL` | optional - overrides response header | `public,max-age=31536000` |

## Build Options

Expand All @@ -61,6 +63,7 @@ Use a `.env` file to set the following options when building the app with `npm r
## Documentation

Please visit [the UNPKG website](https://unpkg.com) to learn more about how to use it.
Visit [GitLab docs](https://docs.gitlab.com/ee/api/packages/npm.html) to learn more about npm rigestry in GitLab.

## Sponsors

Expand Down
7 changes: 5 additions & 2 deletions modules/actions/serveFile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,15 @@ export default function serveFile(req, res) {
if (ext) {
tags.push(`${ext}-file`);
}

const cacheControl =
process.env.CACHE_CONTROL;
res
.set({
'Content-Type': getContentTypeHeader(req.entry.contentType),
'Content-Length': req.entry.size,
'Cache-Control': 'public, max-age=31536000', // 1 year
'Cache-Control': cacheControl
? cacheControl
: 'public, max-age=31536000', // 1 year
'Last-Modified': req.entry.lastModified,
ETag: etag(req.entry.content),
'Cache-Tag': tags.join(', ')
Expand Down
5 changes: 4 additions & 1 deletion modules/utils/npm.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ import bufferStream from './bufferStream.js';
const npmRegistryURL =
process.env.NPM_REGISTRY_URL || 'https://registry.npmjs.org';

const gitlabRegistry =
process.env.GITLAB_REGISTRY;

const agent = new https.Agent({
keepAlive: true
});
Expand Down Expand Up @@ -167,7 +170,7 @@ export async function getPackageConfig(packageName, version, log) {
* Returns a stream of the tarball'd contents of the given package.
*/
export async function getPackage(packageName, version, log) {
const tarballName = isScopedPackageName(packageName)
const tarballName = isScopedPackageName(packageName) && !gitlabRegistry
? packageName.split('/')[1]
: packageName;
const tarballURL = `${npmRegistryURL}/${packageName}/-/${tarballName}-${version}.tgz`;
Expand Down