Incorrect references to xmldom

Question

Incorrect references to xmldom

trmpowell opened this issue 3 years ago · comments

To Reproduce

npm i --save passport-saml@latest
Search /node_modules/passport-saml for xmldom
You'll find /lib/node-saml/xml.js correctly requires @xmldom/xmldom
but files:

/lib/passport-saml/saml.js
/lib/passport-saml/xml.js
/lib/src/passport-saml/saml.js

are incorrectly requiring xmldom.

When we build our application with this version of passport-saml, we are seeing this error:
Cannot find module 'xmldom'

Expected behavior

This version of passport-saml should have no dependencies on xmldom package.

Environment

Node.js version: 14.17.1
passport-saml version: 3.1.2

srd90 · Answer 1 · Fri Sep 10 2021 03:10:53 GMT+0800 (China Standard Time)

It looks as if https://registry.npmjs.org/passport-saml/-/passport-saml-3.1.2.tgz (and quite a few other 3.x.x packages) would have been built and packaged from "non-clean" environment because passport-saml directory contains e.g. xml.js which was moved to node-saml directory. I.e. its as if package would contain 2.x.x stuff also (which would explain why there are few files which reference to unscoped xmldom package) .

Here is content of passport-saml-3.1.2.tgz at npmjs:

.
├── CHANGELOG.md
├── lib
│   ├── node-saml
│   │   ├── algorithms.d.ts
│   │   ├── algorithms.js
│   │   ├── algorithms.js.map
│   │   ├── index.d.ts
│   │   ├── index.js
│   │   ├── index.js.map
│   │   ├── inmemory-cache-provider.d.ts
│   │   ├── inmemory-cache-provider.js
│   │   ├── inmemory-cache-provider.js.map
│   │   ├── saml.d.ts
│   │   ├── saml.js
│   │   ├── saml.js.map
│   │   ├── saml-post-signing.d.ts
│   │   ├── saml-post-signing.js
│   │   ├── saml-post-signing.js.map
│   │   ├── types.d.ts
│   │   ├── types.js
│   │   ├── types.js.map
│   │   ├── utility.d.ts
│   │   ├── utility.js
│   │   ├── utility.js.map
│   │   ├── xml.d.ts
│   │   ├── xml.js
│   │   └── xml.js.map
│   ├── passport-saml
│   │   ├── algorithms.d.ts
│   │   ├── algorithms.js
│   │   ├── algorithms.js.map
│   │   ├── index.d.ts
│   │   ├── index.js
│   │   ├── index.js.map
│   │   ├── inmemory-cache-provider.d.ts
│   │   ├── inmemory-cache-provider.js
│   │   ├── inmemory-cache-provider.js.map
│   │   ├── multiSamlStrategy.d.ts
│   │   ├── multiSamlStrategy.js
│   │   ├── multiSamlStrategy.js.map
│   │   ├── saml.d.ts
│   │   ├── saml.js
│   │   ├── saml.js.map
│   │   ├── saml-post-signing.d.ts
│   │   ├── saml-post-signing.js
│   │   ├── saml-post-signing.js.map
│   │   ├── strategy.d.ts
│   │   ├── strategy.js
│   │   ├── strategy.js.map
│   │   ├── types.d.ts
│   │   ├── types.js
│   │   ├── types.js.map
│   │   ├── utility.d.ts
│   │   ├── utility.js
│   │   ├── utility.js.map
│   │   ├── xml.d.ts
│   │   ├── xml.js
│   │   └── xml.js.map
│   ├── src
│   │   └── passport-saml
│   │       ├── algorithms.d.ts
│   │       ├── algorithms.js
│   │       ├── algorithms.js.map
│   │       ├── index.d.ts
│   │       ├── index.js
│   │       ├── index.js.map
│   │       ├── inmemory-cache-provider.d.ts
│   │       ├── inmemory-cache-provider.js
│   │       ├── inmemory-cache-provider.js.map
│   │       ├── multiSamlStrategy.d.ts
│   │       ├── multiSamlStrategy.js
│   │       ├── multiSamlStrategy.js.map
│   │       ├── saml.d.ts
│   │       ├── saml.js
│   │       ├── saml.js.map
│   │       ├── saml-post-signing.d.ts
│   │       ├── saml-post-signing.js
│   │       ├── saml-post-signing.js.map
│   │       ├── strategy.d.ts
│   │       ├── strategy.js
│   │       ├── strategy.js.map
│   │       ├── types.d.ts
│   │       ├── types.js
│   │       └── types.js.map
│   ├── test.d.ts
│   ├── test.js
│   └── test.js.map
├── LICENSE
├── package.json
└── README.md

5 directories, 85 files

Reference content from clean env

mkdir -p /tmp/foo
cd /tmp/foo
git clone https://github.com/node-saml/passport-saml.git
cd passport-saml
git checkout v3.1.2
npm ci
npm run build
npm pack
# and content of packed passport-saml-3.1.2.tgz is:
.
├── CHANGELOG.md
├── lib
│   ├── node-saml
│   │   ├── algorithms.d.ts
│   │   ├── algorithms.js
│   │   ├── algorithms.js.map
│   │   ├── index.d.ts
│   │   ├── index.js
│   │   ├── index.js.map
│   │   ├── inmemory-cache-provider.d.ts
│   │   ├── inmemory-cache-provider.js
│   │   ├── inmemory-cache-provider.js.map
│   │   ├── saml.d.ts
│   │   ├── saml.js
│   │   ├── saml.js.map
│   │   ├── saml-post-signing.d.ts
│   │   ├── saml-post-signing.js
│   │   ├── saml-post-signing.js.map
│   │   ├── types.d.ts
│   │   ├── types.js
│   │   ├── types.js.map
│   │   ├── utility.d.ts
│   │   ├── utility.js
│   │   ├── utility.js.map
│   │   ├── xml.d.ts
│   │   ├── xml.js
│   │   └── xml.js.map
│   └── passport-saml
│       ├── index.d.ts
│       ├── index.js
│       ├── index.js.map
│       ├── multiSamlStrategy.d.ts
│       ├── multiSamlStrategy.js
│       ├── multiSamlStrategy.js.map
│       ├── strategy.d.ts
│       ├── strategy.js
│       ├── strategy.js.map
│       ├── types.d.ts
│       ├── types.js
│       └── types.js.map
├── LICENSE
├── package.json
└── README.md

3 directories, 40 files

@cjbarth @markstos

Mark Stosberg · Answer 2 · Fri Sep 10 2021 05:29:54 GMT+0800 (China Standard Time)

Thanks for bringing this to our attention. @cjbarth are you able to repackage in a clean environment?

On Thu, Sep 9, 2021 at 3:11 PM srd90 ***@***.***> wrote: It looks as if https://registry.npmjs.org/passport-saml/-/passport-saml-3.1.2.tgz (and quite a few other 3.x.x packages) would have been built and packaged from "non-clean" environment because passport-saml directory contains e.g. xml.js which was moved to node-saml directory. I.e. its as if package would contain 2.x.x stuff also (which would explain why there are few files which reference to unscoped xmldom package) . Here is content of passport-saml-3.1.2.tgz <https://registry.npmjs.org/passport-saml/-/passport-saml-3.1.2.tgz> at npmjs: . ├── CHANGELOG.md ├── lib │ ├── node-saml │ │ ├── algorithms.d.ts │ │ ├── algorithms.js │ │ ├── algorithms.js.map │ │ ├── index.d.ts │ │ ├── index.js │ │ ├── index.js.map │ │ ├── inmemory-cache-provider.d.ts │ │ ├── inmemory-cache-provider.js │ │ ├── inmemory-cache-provider.js.map │ │ ├── saml.d.ts │ │ ├── saml.js │ │ ├── saml.js.map │ │ ├── saml-post-signing.d.ts │ │ ├── saml-post-signing.js │ │ ├── saml-post-signing.js.map │ │ ├── types.d.ts │ │ ├── types.js │ │ ├── types.js.map │ │ ├── utility.d.ts │ │ ├── utility.js │ │ ├── utility.js.map │ │ ├── xml.d.ts │ │ ├── xml.js │ │ └── xml.js.map │ ├── passport-saml │ │ ├── algorithms.d.ts │ │ ├── algorithms.js │ │ ├── algorithms.js.map │ │ ├── index.d.ts │ │ ├── index.js │ │ ├── index.js.map │ │ ├── inmemory-cache-provider.d.ts │ │ ├── inmemory-cache-provider.js │ │ ├── inmemory-cache-provider.js.map │ │ ├── multiSamlStrategy.d.ts │ │ ├── multiSamlStrategy.js │ │ ├── multiSamlStrategy.js.map │ │ ├── saml.d.ts │ │ ├── saml.js │ │ ├── saml.js.map │ │ ├── saml-post-signing.d.ts │ │ ├── saml-post-signing.js │ │ ├── saml-post-signing.js.map │ │ ├── strategy.d.ts │ │ ├── strategy.js │ │ ├── strategy.js.map │ │ ├── types.d.ts │ │ ├── types.js │ │ ├── types.js.map │ │ ├── utility.d.ts │ │ ├── utility.js │ │ ├── utility.js.map │ │ ├── xml.d.ts │ │ ├── xml.js │ │ └── xml.js.map │ ├── src │ │ └── passport-saml │ │ ├── algorithms.d.ts │ │ ├── algorithms.js │ │ ├── algorithms.js.map │ │ ├── index.d.ts │ │ ├── index.js │ │ ├── index.js.map │ │ ├── inmemory-cache-provider.d.ts │ │ ├── inmemory-cache-provider.js │ │ ├── inmemory-cache-provider.js.map │ │ ├── multiSamlStrategy.d.ts │ │ ├── multiSamlStrategy.js │ │ ├── multiSamlStrategy.js.map │ │ ├── saml.d.ts │ │ ├── saml.js │ │ ├── saml.js.map │ │ ├── saml-post-signing.d.ts │ │ ├── saml-post-signing.js │ │ ├── saml-post-signing.js.map │ │ ├── strategy.d.ts │ │ ├── strategy.js │ │ ├── strategy.js.map │ │ ├── types.d.ts │ │ ├── types.js │ │ └── types.js.map │ ├── test.d.ts │ ├── test.js │ └── test.js.map ├── LICENSE ├── package.json └── README.md 5 directories, 85 files Reference content from clean env mkdir -p /tmp/foocd /tmp/foo git clone https://github.com/node-saml/passport-saml.gitcd passport-saml git checkout v3.1.2 npm ci npm run build npm pack# and content of packed passport-saml-3.1.2.tgz is:. ├── CHANGELOG.md ├── lib │ ├── node-saml │ │ ├── algorithms.d.ts │ │ ├── algorithms.js │ │ ├── algorithms.js.map │ │ ├── index.d.ts │ │ ├── index.js │ │ ├── index.js.map │ │ ├── inmemory-cache-provider.d.ts │ │ ├── inmemory-cache-provider.js │ │ ├── inmemory-cache-provider.js.map │ │ ├── saml.d.ts │ │ ├── saml.js │ │ ├── saml.js.map │ │ ├── saml-post-signing.d.ts │ │ ├── saml-post-signing.js │ │ ├── saml-post-signing.js.map │ │ ├── types.d.ts │ │ ├── types.js │ │ ├── types.js.map │ │ ├── utility.d.ts │ │ ├── utility.js │ │ ├── utility.js.map │ │ ├── xml.d.ts │ │ ├── xml.js │ │ └── xml.js.map │ └── passport-saml │ ├── index.d.ts │ ├── index.js │ ├── index.js.map │ ├── multiSamlStrategy.d.ts │ ├── multiSamlStrategy.js │ ├── multiSamlStrategy.js.map │ ├── strategy.d.ts │ ├── strategy.js │ ├── strategy.js.map │ ├── types.d.ts │ ├── types.js │ └── types.js.map ├── LICENSE ├── package.json └── README.md 3 directories, 40 files @cjbarth <https://github.com/cjbarth> @markstos <https://github.com/markstos> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#637 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAGJZMJRBMBGAPDA3Y5B4TUBEBEPANCNFSM5DWKWSLQ> .

-- *Mark Stosberg* (he/him) Director of Systems & Security ***@***.*** | 765.277.1916 https://www.rideamigos.com <https://rideamigos.com/> Changing the way the world commutes. <https://www.linkedin.com/company/rideamigos> <https://www.twitter.com/rideamigos> <https://www.facebook.com/rideamigos> <https://www.instagram.com/rideamigos> <https://rideamigos.com/newsletter-sign-up/>

Tracy · Answer 3 · Mon Sep 20 2021 09:16:17 GMT+0800 (China Standard Time)

@cjbarth @markstos, any idea when this might be resolved?

Chris Barth · Answer 4 · Mon Sep 20 2021 21:04:06 GMT+0800 (China Standard Time)

I hesitate to just repackage as-is. I'll update all the dependencies, make sure I do a git clean -xfd, and then package. Will that work?

Chris Barth · Answer 5 · Mon Sep 20 2021 22:30:16 GMT+0800 (China Standard Time)

I've created a PR for this: #640

Once this lands, I'll call it a 3.2.0 release and get it out.

Chris Barth · Answer 6 · Sat Sep 25 2021 09:40:20 GMT+0800 (China Standard Time)

Version 3.2.0 was released. This should fix the issue.

Tracy · Answer 7 · Tue Oct 05 2021 11:36:27 GMT+0800 (China Standard Time)

Thanks, @cjbarth ! We will give it a shot!