Skip to content
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.

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

Use content hash vs. freshness in publish registry #498

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ jobs:
run: yarn lint
- name: test
run: yarn test
publish-registry-dry-run:
needs: build_and_test
uses: ./.github/workflows/publish-registry.yml
with:
dry-run: true
publish_alpha:
name: publish alpha release
runs-on: ubuntu-latest
Expand Down
11 changes: 9 additions & 2 deletions .github/workflows/publish-registry.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,14 @@ on:
schedule:
# https://crontab.guru/#0_0_*_*_0
- cron: 0 0 * * 0
workflow_call:
inputs:
dry-run:
type: boolean
workflow_dispatch:
inputs:
dry-run:
type: boolean
jobs:
publish-registry:
runs-on: ubuntu-latest
Expand All @@ -21,8 +28,8 @@ jobs:
path: packages/utils/cache/
key: cache-${{ github.run_id }}
restore-keys: cache-
- name: Publish registry
run: yarn workspace @definitelytyped/publisher publish-registry
- name: Publish registry${{ (inputs || github.event.inputs).dry-run && ' dry run' || '' }}
run: yarn workspace @definitelytyped/publisher publish-registry${{ (inputs || github.event.inputs).dry-run && ' --dry' || '' }}
env:
NPM_TOKEN: ${{ secrets.NPM_RETAG_TOKEN }}
- if: always()
Expand Down
1 change: 1 addition & 0 deletions packages/publisher/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"fstream": "^1.0.12",
"hh-mm-ss": "^1.2.0",
"longjohn": "^0.2.11",
"npm-pick-manifest": "^7.0.1",
"pacote": "^13.6.1",
"semver": "^7.3.7",
"source-map-support": "^0.4.0",
Expand Down
28 changes: 24 additions & 4 deletions packages/publisher/src/publish-registry.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import assert = require("assert");
import process from "process";
import { emptyDir } from "fs-extra";
// @ts-expect-error
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is the error?

import pickManifest from "npm-pick-manifest";
import * as yargs from "yargs";

import { defaultLocalOptions, defaultRemoteOptions } from "./lib/common";
Expand Down Expand Up @@ -230,10 +232,7 @@ async function generateRegistry(typings: readonly TypingsData[]): Promise<Regist
return {
entries: Object.fromEntries(
await Promise.all(
typings.map(async (typing) => [
typing.name,
filterTags((await pacote.packument(typing.fullNpmName, { cache: cacheDir }))["dist-tags"]),
])
typings.map(async (typing) => [typing.name, filterTags((await revalidate(typing))["dist-tags"])])
)
),
};
Expand All @@ -245,6 +244,27 @@ async function generateRegistry(typings: readonly TypingsData[]): Promise<Regist
}
}

/** Fetch packument from the cache or the network, depending on whether the types have changed or not. */
async function revalidate(typing: TypingsData) {
const offline = await pacote
.packument(typing.fullNpmName, { cache: cacheDir, fullMetadata: true, offline: true })
.catch((reason) => {
if (reason.code !== "ENOTCACHED") throw reason;
return undefined;
});
try {
if (
offline &&
pickManifest(offline, `~${typing.major}.${typing.minor}`).typesPublisherContentHash === typing.contentHash
)
return offline;
// @ts-expect-error
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

} catch (reason: {}) {
if (reason.code !== "ETARGET") throw reason;
}
return pacote.packument(typing.fullNpmName, { cache: cacheDir, fullMetadata: true, preferOnline: true });
}

interface ProcessedNpmInfo {
readonly latestVersion: string;
readonly maxVersion: string;
Expand Down
2 changes: 1 addition & 1 deletion yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -6952,7 +6952,7 @@ npm-pick-manifest@^6.0.0, npm-pick-manifest@^6.1.1:
npm-package-arg "^8.1.2"
semver "^7.3.4"

npm-pick-manifest@^7.0.0:
npm-pick-manifest@^7.0.0, npm-pick-manifest@^7.0.1:
version "7.0.1"
resolved "https://registry.yarnpkg.com/npm-pick-manifest/-/npm-pick-manifest-7.0.1.tgz#76dda30a7cd6b99be822217a935c2f5eacdaca4c"
integrity sha512-IA8+tuv8KujbsbLQvselW2XQgmXWS47t3CB0ZrzsRZ82DbDfkcFunOaPm4X7qNuhMfq+FmV7hQT4iFVpHqV7mg==
Expand Down