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

chore: remove shrinkwrap #1985

Closed
wants to merge 1 commit into from
Closed

chore: remove shrinkwrap #1985

wants to merge 1 commit into from

Conversation

KazuCocoa
Copy link
Member

@KazuCocoa KazuCocoa commented Sep 14, 2023

Noticed current uia2, xcuitest and probably other drivers also no longer include npm-shrinkwrap.json in the published packages.

So maybe every install installs the latest dependencies in the package.json even when am installation command specifies an older version. (This is not good)

This repository already has lock file, so maybe we can remove npm shrinkwrap, then can expect the lock file will be part of npm install module to lock dependencies...? The npm command converts package-lock.json to npm-shrinkwrap.json so just removing it will keep package-lock.json I assume...

If this works, we may be able to add package-lock.json file in each driver's top directory as same as this xcuitest to lock dependencies for each package versions

e.g.
Screenshot 2023-09-14 at 1 35 46 AM

5.0.0 no longer had. 4.32.0 still had, but 4.32.23 did not.

So I guess typescript update affected this...? Then, other drivers started recently???

@mykola-mokhnach
Copy link
Contributor

mykola-mokhnach commented Sep 14, 2023

I am still in doubts regarding whether it makes sense to have package.lock
Each minor module update creates lot of unnecessary noise and is anyway merged automatically in 99% of cases.
That is why I tend to rather shrinkwrap drivers on release and remove package.lock, which would create less work for us as maintainers.
WDYT @jlipps ?

@KazuCocoa
Copy link
Member Author

Yes, understood.

I like to not consider patch versions so much, but would like to lock minor/major for releases.
For example, the appium-ios-simulator 5.3.0 is released recently. In the timing itself as appium-xcuitest-driver is it is in 5.1.0, but currently it is available in xcuitest driver 5.0.0 as well by installing the driver after the appium-ios-simulator 5.3.0 release. This could be aa preference matter as we have no major issues by this recently since breaking changes have major version update so far. Actually we introduced breaking changes as minor in the past, but not recently

@jlipps
Copy link
Member

jlipps commented Sep 18, 2023

I don't think I have a strong opinion anymore. The shrinkwrap-on-release strategy without package-lock has worked well in the past, but if you want to trial a change in this repo i think that's fine.

@mykola-mokhnach
Copy link
Contributor

we for sure need to have either shrinkwrap or package.lock

both of them have their own pros and cons

Until now the package.lock approach was ok'ish with automerge enabled and tests being green (after 10% failure threshold has been added ;) )

I would still prefer to get rid of package.lock though and only have shrinkwrap on release as such approach requires less maintenance.

@KazuCocoa
Copy link
Member Author

it seems like npm-shrinkwrap.json stared excluding in the published package since 4.32.6. .5 still had.
Not clear why, thus trying something right now

@KazuCocoa
Copy link
Member Author

Ok, #2023 (comment) fixed the missing npm-shrinkwrap.json from published package, that was my original issue for this pr.

Lets close this since latest release includes npm-shrinkwrap.json properly right now. I'll do the same thing in other drivers

@KazuCocoa KazuCocoa closed this Sep 24, 2023
@KazuCocoa KazuCocoa deleted the KazuCocoa-patch-1 branch September 24, 2023 07:21
@KazuCocoa
Copy link
Member Author

Applied the same update to other drivers that did not have npm-shrinkwrap.json since someday (maybe similar timeline this xcuitest driver started missing that)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants