[gatsby-source-filesystem] Incorrect type definition for createFileNodeForAsset

[Joe-Edwards]

Preliminary Checks

• This issue is not a duplicate. Before opening a new issue, please search existing issues: https://github.com/gatsbyjs/gatsby/issues
• This issue is not a question, feature request, RFC, or anything other than a bug report directly related to Gatsby. Please post those things in GitHub Discussions: https://github.com/gatsbyjs/gatsby/discussions

Description

The type definition for createRemoteFileNode (specifically the CreateRemoteFileNodeArgs interface) doesn't match the documentation or implementation, in particular:

• store is mandatory in the types, but not present in the docs or implementation
• cache is mandatory in the types, but not present in the docs, and optional in the implementation
• getCache is missing from the types, but mandatory in the docs, and optional in the implementation (but you must pass one of cache or getCache)
• reporter is mandatory in the types, but not present in the docs or implementation

Steps to Reproduce

1. Use Typescript gatsby-node.ts
2. Use the createRemoteFileNode function as documented:

  const fileNode = createRemoteFileNode({
    url: encodeURI(node.url),
    getCache, // Object literal may only specify known properties, and 'getCache' does not exist in type 'CreateRemoteFileNodeArgs'.
    createNode,
    createNodeId,
    parentNodeId: node.id,
  });

Expected Result

Typescript compiles successfully

Actual Result

Type errors being reported due to incorrect arguments

Environment

System:
    OS: Windows 10 10.0.19044
    CPU: (12) x64 Intel(R) Core(TM) i9-8950HK CPU @ 2.90GHz
  Binaries:
    Node: 16.14.2 - C:\Program Files\nodejs\node.EXE
    Yarn: 1.16.0 - C:\Program Files (x86)\Yarn\bin\yarn.CMD
    npm: 8.6.0 - C:\Program Files\nodejs\npm.CMD
  npmPackages:
    gatsby: ^4.10.3 => 4.10.3 
    gatsby-plugin-eslint: ^4.0.2 => 4.0.2 
    gatsby-plugin-image: 2.10.1 => 2.10.1 
    gatsby-plugin-react-helmet-async: ^1.2.1 => 1.2.1 
    gatsby-plugin-styled-components: ^5.10.0 => 5.10.0 
    gatsby-source-contentstack: 4.0.1 => 4.0.1 
    gatsby-source-filesystem: ^4.10.1 => 4.10.1 
    gatsby-transformer-json: ^4.10.0 => 4.10.0

Config Flags

No response

[LekoArts]

Hi, thanks for the issue!

Indeed, the TypeScript definition diverged from what is actually correct now.

The TypeScript definitions are here:

gatsby/packages/gatsby-source-filesystem/index.d.ts

Lines 29 to 45 in b669468

	export interface CreateRemoteFileNodeArgs {
	url: string
	store: Store
	// TODO: use GatsbyCache type (requires [email protected])
	cache: NodePluginArgs["cache"]
	createNode: Function
	createNodeId: Function
	parentNodeId?: string
	auth?: {
	htaccess_user: string
	htaccess_pass: string
	}
	httpHeaders?: object
	ext?: string
	name?: string
	reporter: object
	}

A reference for what it actually should be is https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-source-filesystem/src/create-remote-file-node.js#L105 and

gatsby/packages/gatsby-source-filesystem/src/create-remote-file-node.js

Lines 26 to 37 in b669468

	/**
	* @typedef {CreateRemoteFileNodePayload}
	* @typedef {Object}
	* @description Create Remote File Node Payload
	*
	* @param {String} options.url
	* @param {GatsbyCache} options.cache
	* @param {Function} options.createNode
	* @param {Function} options.getCache
	* @param {Auth} [options.auth]
	* @param {Reporter} [options.reporter]
	*/

[Apprentice76]

Hi, can I work on this? If I understand right, I have to modify the index.d.ts to match the references, like adding the missing argument and setting the others to optional when required.

[darylwright]

I looked into it a bit yesterday, although I don't think I'm going to implement this change. It seems that the index.d.ts will have to change. One thing that's bothering me is that the reporter field is defined in the CreateRemoteFileNodePayload type, but it isn't used when calling createRemoteFileNode(). Could it simply be omitted? Not sure what its purpose is. Here's what I believe the payload object type should look like so far:

export interface CreateRemoteFileNodePayload {
  url: string
  cache?: GatsbyCache
  getCache?: Function
  createNode: Function
  createNodeId: Function
  parentNodeId?: string
  auth?: {
    htaccess_user: string
    htaccess_pass: string
  }
  httpHeaders?: object // could also be `{ [key: string]: string }`?
  ext?: string
  name?: string
}

[Apprentice76]

The same thing as been bothering me but the function description here

gatsby/packages/gatsby-source-filesystem/src/create-remote-file-node.js

Lines 26 to 37 in f63d13d

	/**
	* @typedef {CreateRemoteFileNodePayload}
	* @typedef {Object}
	* @description Create Remote File Node Payload
	*
	* @param {String} options.url
	* @param {GatsbyCache} options.cache
	* @param {Function} options.createNode
	* @param {Function} options.getCache
	* @param {Auth} [options.auth]
	* @param {Reporter} [options.reporter]
	*/

has me confused as to whether the reporter param is required or not, should I remove this line as well?

I'm removing the Store param as it's not mentioned in the refrences.

Also I noticed, that createFileNodeFromBuffer has the same issue, should I change that as well? Here

gatsby/packages/gatsby-source-filesystem/index.d.ts

Lines 47 to 58 in b669468

	export interface CreateFileNodeFromBufferArgs {
	buffer: Buffer
	store: Store
	// TODO: use GatsbyCache type (requires [email protected])
	cache: NodePluginArgs["cache"]
	createNode: Function
	createNodeId: Function
	parentNodeId?: string
	hash?: string
	ext?: string
	name?: string
	}

when it should be like

gatsby/packages/gatsby-source-filesystem/src/create-file-node-from-buffer.js

Lines 118 to 129 in f63d13d

	module.exports = ({
	buffer,
	hash,
	cache,
	createNode,
	getCache,
	parentNodeId = null,
	createNodeId,
	ext,
	name,
	}) => {
	// validation of the input

If someone would confirm this, I'll push the changes.

[github-actions]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 60 days of inactivity. It’s been at least 20 days since the last update here.
If we missed this issue or if you want to keep it open, please reply here.
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

[Joe-Edwards]

This is still an issue, looks like the PR #35422 has got stuck

[github-actions]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 60 days of inactivity. It’s been at least 20 days since the last update here.
If we missed this issue or if you want to keep it open, please reply here.
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜