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.

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

fix: add npm tag lookup to determineChannel correctly #563

Merged
merged 5 commits into from
Jun 5, 2023
Merged

fix: add npm tag lookup to determineChannel correctly #563

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b277ae3
fix: add npm tag lookup to determineChannel correctly
WillieRuemmele May 22, 2023
a29de42
chore: convert from npm tags to oclif defaults
WillieRuemmele May 22, 2023
725808b
Merge branch 'main' into wr/fixUpdateVersionTag
WillieRuemmele Jun 5, 2023
98f2c10
chore: use channel file for default, then back to 'stable'
WillieRuemmele Jun 5, 2023
8401d6e
chore: byor
WillieRuemmele Jun 5, 2023
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
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@
/package-lock.json
/tmp
/oclif-plugin-update-*.tgz
/.vscode
/.vscode
/.idea
27 changes: 0 additions & 27 deletions src/github.ts
View file
Open in desktop

This file was deleted.

22 changes: 13 additions & 9 deletions src/update.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export class Updater {
return
}

const channel = options.channel || await this.determineChannel()
const channel = options.channel || await this.determineChannel(version)
const current = await this.determineCurrentVersion()

if (version) {
Expand Down Expand Up @@ -268,14 +268,18 @@ export class Updater {
return current === updated
}

private async determineChannel(): Promise<string> {
const channelPath = path.join(this.config.dataDir, 'channel')
if (fs.existsSync(channelPath)) {
const channel = await fs.readFile(channelPath, 'utf8')
return String(channel).trim()
private async determineChannel(version:string|undefined): Promise<string> {
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
private async determineChannel(version:string|undefined): Promise<string> {
private async determineChannel(version?:string): Promise<string> {

try {
const {body} = await HTTP.get(`https://registry.npmjs.org/${this.config.pjson.name}/`)
Copy link
Member

Choose a reason for hiding this comment

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

proxy should be ok. That library looks to have implemented it
https://github.com/search?q=repo%3Aheroku%2Fhttp-call%20proxy&type=code

const tags = (body as {'dist-tags': Record<string, string>})['dist-tags']
const tag = Object.keys(tags).find(v => tags[v] === version) ?? 'stable'
// convert from npm style tag defaults to OCLIF style
if (tag === 'latest') return 'stable'
if (tag === 'latest-rc') return 'stable-rc'
return tag
} catch {
return 'stable'
Copy link
Member

@mshanemc mshanemc May 31, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

is stable the right default? Would it be more accurate to fall back to what's in the channel file, like the original implementation did, then stable as a last resort?

}

return this.config.channel || 'stable'
}

private determinePlatform(): Interfaces.PlatformTypes {
Expand Down Expand Up @@ -303,7 +307,7 @@ export class Updater {

private async setChannel(channel: string): Promise<void> {
const channelPath = path.join(this.config.dataDir, 'channel')
fs.writeFile(channelPath, channel, 'utf8')
await fs.writeFile(channelPath, channel, 'utf8')
}

private async logChop(): Promise<void> {
Expand Down