EmbeddedResource seems to be ignored for the XML Type Provider

[rabejens]

I am using the XML Type Provider with FSharp.Data. I have a line like this:

type internal SomethingFromXML = XmlProvider<"./Sample.xml", EmbeddedResource="MyLib, Sample.xml">

I set the Sample.xml to "Embedded Resource, Do Not Copy".

I packed the MyLib to a NuGet package and used it in another program. But when I now execute it, I get a DirectoryNotFoundException saying it can't find C:\Path\To\My\SolutionWithMyLib\MyLib\Sample.xml

So, it seems to ignore the EmbeddedResource directive. Is that not supported with the XML Provider?

Followup

I found #1191 and changed the EmbeddedResource to MyLib, MyLib.Sample.xml but that did not change anything.

[ArtemyB]

@rabejens I am also using XML Type Provider but do not have any errors (however there were some a couple of months ago). I've also tried packing my library with TP-provided types into NuGet-package and it also has worked for me. Based on your message it seems that your actions should be correct. The only differences between your case and mine:

1. I am using XML Schema File (".xsd") instead of sample XML.
2. My sample file located in the subfolder. I.e. if the subfolder name is "Data" then my TP call looks like that:

type XmlData = XmlProvider<Schema = "Data/MySchema.xsd", EmbeddedResource = "MyLib, MyLib.Data.MySchema.xsd">

[MaybeSacred]

@ArtemyB's fix worked for me, note that the EmbeddedResource string appears to be case-sensitive with regards to the file names

[Evangelink]

Hi there,

I am facing the same issue... I have tried to apply the previous comments but nothing is working. It seems to always rely on the local file, so when I get rid of it, I get an exception.

Anyone with some idea?

[ArtemyB]

@Evangelink hi, can't suggest anything else for now -- I'm still using the library which I created then and all is done according to the description in my comment above. But FSharp.Data dependency hasn't been updating since then and is v3.3.3 -- maybe something has changed in the newer version 🤔

However I've noticed one more detail not mentioned there previously -- the .xml/.xsd file should be added as an embedded resource to the project, so its' "Build action" property should be in "EmbeddedResource" state or, in other words, in project-file its entry should look like <EmbeddedResource Include="MyDataDirectory\MyXmlSchema.xsd"></EmbeddedResource> (if file's relative path is "MyDataDirectory\MyXmlSchema.xsd" of course).

[sproott]

Hi there,

I am facing the same issue... I have tried to apply the previous comments but nothing is working. It seems to always rely on the local file, so when I get rid of it, I get an exception.

Anyone with some idea?

I had the same issue, re-checked the embedded resource path and everything was OK. After some debugging, I realized I had defined the provided type inside a namespace, not a module, which I realized could mess with the type's assembly and therefore embedded resources. After putting the type into a module, everything works.

EDIT: nevermind, it still doesn't work, probably tested it wrong

[sproott]

For me, the problem seems to arise when GetSchema is called. I've noticed in this section that the resource is not being taken into account. Shouldn't GetSchema also first try to load the embedded resource, or am I misunderstanding something?

[github-actions]

🤖 This is an automated response from Repo Assist.

Thanks to @sproott for the excellent code-level analysis in the previous comment. Having investigated the source, I can confirm and expand on it:

Root cause

The EmbeddedResource path works for XmlProvider with a sample XML file: at design time tryGetResource reads the embedded resource, sets IsResource = true, and the generated GetSample method is omitted (so no file path baked in). ✅

However, there are two remaining gaps:

1. Schema = "..." (XSD) + EmbeddedResource: The Schema _ branch in Helpers.fs generates a GetSchema method that calls asyncReadTextAtRuntimeWithDesignTimeRules with the original design-time file path — it doesn't check IsResource at all (see the Schema _ case ~line 728). At runtime on another machine this path doesn't exist.

2. tryGetResource returning None silently: If the EmbeddedResource string is wrong (wrong assembly name, wrong case, or missing namespace prefix), tryGetResource returns None, IsResource stays false, and the generated GetSample bakes in the design-time file path — causing DirectoryNotFoundException at runtime.

Immediate workaround

Ensure the EmbeddedResource string exactly matches:

XmlProvider<"Sample.xml", EmbeddedResource="MyLib, MyLib.Sample.xml">
//                                          ^^^^^^^  ^^^^^^^^^^^^^^^^^
//                                   Assembly name  Fully-qualified resource name (case-sensitive)

The resource name is the assembly name + . + any subfolder dots + filename, matching what you see via Assembly.GetManifestResourceNames().

For XSD schemas, the GetSchema bug is a genuine code defect that needs fixing in Helpers.fs.

Generated by Repo Assist

To install this workflow, run gh aw add githubnext/agentics/workflows/repo-assist.md@0d6e8cf9db90470cd5477c6a40b350fd9f9e1422. View source at https://github.com/githubnext/agentics/tree/0d6e8cf9db90470cd5477c6a40b350fd9f9e1422/workflows/repo-assist.md.

[dsyme]

For XSD schemas, the GetSchema bug is a genuine code defect that needs fixing in Helpers.fs.

This fix should be done

[github-actions]

🤖 This is an automated response from Repo Assist.

I've implemented the fix for the GetSchema / EmbeddedResource bug and opened a draft PR — please see the PR for full details.

Root cause (confirmed by @sproott's analysis and @dsyme's endorsement):

The GetSchema method was generated inside an if not parseResult.IsResource then guard in Helpers.fs. When EmbeddedResource is correctly specified and the resource is found at design time, IsResource = true, so GetSchema was never generated. When it was incorrectly specified, the method was generated but with the design-time file path baked in, causing DirectoryNotFoundException at runtime on other machines.

The fix moves GetSchema generation outside that guard and adds a new branch for the IsResource = true case that reads the XSD from the embedded resource at runtime via AppDomain.CurrentDomain.GetAssemblies().

Generated by Repo Assist

To install this workflow, run gh aw add githubnext/agentics/workflows/repo-assist.md@de40494d3f62516449f458c4f8d8d2fe370708fe. View source at https://github.com/githubnext/agentics/tree/de40494d3f62516449f458c4f8d8d2fe370708fe/workflows/repo-assist.md.