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

feat: add .mapping(dep) shorthand method to resolve mapped bare imports directly #112

Merged
merged 2 commits into from
Sep 23, 2022
Merged
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
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,37 @@ If `integrity` of the file is not available, the value for `integrity` will be `

Returns the import maps defined in Eik config from the Eik server. For the maps to be returned they need to be loaded from the Eik server. This is done by setting the `loadMaps` option on the constructor to `true`.

### .mapping(identifier)

Returns the last mapping entry for a given bare import `identifier`.
`identifier` is a `string` key from an import map and the returned `string` is a the matching value from the same import map entry.

#### arguments

| option | default | type | required | details |
| ---------- | ------- | -------- | -------- | ------------------- |
| identifier | | `string` | `true` | Bare import map key |

**Example:**

If an import map being used looks like:

```json
{
"imports": {
"react": "https://myserver.com/react/18.0.0/react.min.js"
}
}
```

When the mapping method is called:

```js
const absoluteURL = client.mapping('react');
```

`absoluteURL` will be `https://myserver.com/react/18.0.0/react.min.js`

## License

Copyright (c) 2021 FINN.no
Expand Down
31 changes: 21 additions & 10 deletions src/index.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/* eslint-disable no-restricted-syntax */
import { request } from 'undici';
import { join } from 'path';
import loader from '@eik/common-config-loader';
Expand All @@ -6,16 +7,15 @@ import Asset from './asset.js';
const trimSlash = (value = '') => {
if (value.endsWith('/')) return value.substring(0, value.length - 1);
return value;
}
};

const fetchImportMaps = async (urls = []) => {
try{
try {
const maps = urls.map(async (map) => {
const {
statusCode,
body
} = await request(map, { maxRedirections: 2 });

const { statusCode, body } = await request(map, {
maxRedirections: 2,
});

if (statusCode === 404) {
throw new Error('Import map could not be found on server');
} else if (statusCode >= 400 && statusCode < 500) {
Expand All @@ -31,7 +31,7 @@ const fetchImportMaps = async (urls = []) => {
`Unable to load import map file from server: ${err.message}`,
);
}
}
};

export default class NodeClient {
#development;
Expand Down Expand Up @@ -83,7 +83,8 @@ export default class NodeClient {
}

get pathname() {
if (this.#config.type && this.#config.name && this.#config.version) return join('/', this.type, this.name, this.version);
if (this.#config.type && this.#config.name && this.#config.version)
return join('/', this.type, this.name, this.version);
throw new Error('Eik config was not loaded before calling .pathname');
}

Expand All @@ -101,6 +102,16 @@ export default class NodeClient {

maps() {
if (this.#config.version && this.#loadMaps) return this.#maps;
throw new Error('Eik config was not loaded or "loadMaps" is "false" when calling .maps()');
throw new Error(
'Eik config was not loaded or "loadMaps" is "false" when calling .maps()',
);
}

mapping(dependency) {
let mapping = null;
for (const map of this.maps()) {
Copy link

Choose a reason for hiding this comment

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

This will continue to loop through this.maps even after found a match. You could return the result immediately - unless we can see a scenario where the same dependency exists in multiple maps and we have defined that the last import map takes presedence.

Copy link
Contributor

Choose a reason for hiding this comment

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

This is a pretty interesting point when I think about it.

There might be multiple import maps and two maps (or more) can contain the same identifier but with different targets. Then the question is which one wins. In our build tool plugins the last occurrence wins at the moment (in the plugins the algorithm is a little bit different though, but the result is the same). So, should first or last occurrence win here?

The answer is probably more complex. Import Maps do have a feature to deal with this which is defined under https://github.com/WICG/import-maps#multiple-versions-of-the-same-module. Currently our build tool plugins have a little bit of a naive implementation of the Import Map spec and we do not take scoping into account. We should have full Import Map support though (aka also supporting scoping) and we have an experimental implementation in the ESBuild plugin: eik-lib/esbuild-plugin#71

Ideally this method should actually apply full Import Map parsing and adhere to the algorithm in the spec to decide what to return.

But to be practical here: I think this is fine since this aligns with whats currently happening in the build tools. But, we should do an effort to get support for the whole Import Map spec and in this process get this method to do so too.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've left the code alone and simply updated the docs for now.

if (map?.imports[dependency]) mapping = map.imports[dependency];
}
return mapping;
}
}
13 changes: 13 additions & 0 deletions test/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -255,3 +255,16 @@ tap.test('Client - Retrieve a base - Development mode is set to "false"', async
t.equal(resolved, `${t.context.address}/pkg/eik-fixture/1.0.2`);
t.end();
});

tap.test('Client - Resolve a mapping', async (t) => {
const client = new NodeClient({
path: t.context.fixture,
loadMaps: true,
});
await client.load();

const mapping = client.mapping('eik');

t.equal(mapping, '/src/eik.js');
t.end();
});