launchcodedev / app-config

Easy Configuration Loader with Strict Validation
https://app-config.dev
Mozilla Public License 2.0
68 stars 11 forks source link

No matching export in "@app-config/esbuild:@app-config/main" for import "loadConfig" #208

Open danielsitnik opened 2 years ago

danielsitnik commented 2 years ago

UPDATE (but please see next comment!) Ok, I realize my mistake now. 😳

I just understood that by default the esbuild plugin will bundle (inline) the configuration files and there's no need to use loadConfig anymore. My initial impression was that the plugin was needed to provide some compatibility with esbuild and solve some bundling problem (like the one I mention on the next comment).

This should be more clear in the docs. I only realized it because I was going through the esbuild plugin source code and I found it has an undocumented options object where noBundledConfig = false.

Hello.

I'm trying to use the esbuild plugin, but I'm getting the following error during build:

Screen Shot 2022-08-10 at 18 58 45

I obviously need to call loadConfig somewhere in my application to load the config files.

Changing to import loadConfig from '@app-config/main'; (without brackets) won't throw a build error, but the code obviously won't work, as it now thinks that loadConfig is the same as config (ExportedConfig), which is not a function!

Screen Shot 2022-08-10 at 19 03 40

Please, what am I missing here? Thank you.

danielsitnik commented 2 years ago

One more thing to note here, you have a dependency on openpgpjs 4.x, which has a problem with bundlers. When I bundle my application (without the plugin) and try to run it on AWS Lambda (node 16) I get this error:

{
    "errorType": "Runtime.ImportModuleError",
    "errorMessage": "Error: Cannot find module 'asn1.js'",
    "stack": [
        "Runtime.ImportModuleError: Error: Cannot find module 'asn1.js'",
        "..."
    ]
}

This is mentioned in some issues like this and also this one from the official openpgpjs repo.

They fixed it on version 5.x, so I appreciate if you could update your version as well!

I just tested it with an override on my package.json and it worked liked a charm on AWS Lambda:

"overrides": {
  "@app-config/main": {
      "openpgp": "5.4.0"
  }
}
joelgallant commented 2 years ago

Thanks for the report!

I've primarily worked on the esbuild plugin for web apps, so noBundledConfig was largely just there for completeness. This documentation definitely could be improved.

We should be able to upgrade openpgp as well, hopefully without breaking changes.

joelgallant commented 2 years ago

Release notes: https://github.com/openpgpjs/openpgpjs/releases/tag/v5.0.0

I believe this would necessitate a breaking change in app-config's API, unfortunately, because we do re-export Key in a couple places. Right now we lock all subpackages to the same version, so it would mean a v3 (#130).

danielsitnik commented 2 years ago

Release notes: https://github.com/openpgpjs/openpgpjs/releases/tag/v5.0.0

I believe this would necessitate a breaking change in app-config's API, unfortunately, because we do re-export Key in a couple places. Right now we lock all subpackages to the same version, so it would mean a v3 (#130).

Understood! I can live with my workaround right now since I'm not using encrypted config properties.

On a side note, I'd like to leave a suggestion for maybe putting all the encryption functionality on a separate package. If you don't need encryption, it will "pollute" your bundle, bringing in some heavy dependencies.

Check this report from bundle-buddy.com for my application:

Screen Shot 2022-08-17 at 22 37 32

openpgp and node-forge are responsible for half of my bundle size and I'm not even using them.

joelgallant commented 2 years ago

On a side note, I'd like to leave a suggestion for maybe putting all the encryption functionality on a separate package. If you don't need encryption, it will "pollute" your bundle, bringing in some heavy dependencies.

For sure! This is a core goal of the theoretical V3 already. Encryption is a separate package, but it was included as a "default" parsing extension, so it's included in bundles at the moment. A big part of V3 is to remove more default extensions, letting users choose what they want.