http request and utils scaffolder backend is using deprecated ways of instantiating the plugin

[nia-potato]

Currently when adding

backend.add(import('@roadiehq/scaffolder-backend-module-utils/new-backend'));
backend.add( import('@roadiehq/scaffolder-backend-module-http-request/new-backend'));

because of backstage/backstage#24493 we will be getting an deprecation notice of the below

The signature '(feature: (() => BackendFeature) | Promise<{ default: () => BackendFeature; }>): void' of 'backend.add' is deprecated.ts(6387)
index.d.ts(449, 8): The declaration was marked as deprecated here.

Current Behavior

when adding both http request and utils scaffolder backend plugins to index.ts they should not be deprecated

Steps to Reproduce

be on 1.29.2 of backstage, and install http request and utils scaffolder backend plugin.

Possible Solution

Context

Your Environment

• @backstage/plugin-catalog-react version: ^1.12.2
• @backstage/integration version: ^1.13.0

[GersonTrj]

I see the same issue with: backend.add(import('@roadiehq/catalog-backend-module-okta/new-backend'));

@nia-potato do you have any updates on this issue?

[nia-potato]

i was wondering if someone from roadie can take a look since they have more context than us.

maybe @Xantier

[Xantier]

Is the warning message the issue here?

[nia-potato]

I think the issue here is that because we are still using the deprecated ways of instantiating the plugins, by the next few releases, per the attached issue. they will stop working.

[swnia]

@Xantier the way the plugins are initiated are now deprecated with version 1.30.0. Is there a plan to migrate these to the new way of instantiating backend plugins?

[Xantier]

@Xantier the way the plugins are initiated are now deprecated with version 1.30.0. Is there a plan to migrate these to the new way of instantiating backend plugins?

@camilaibs maybe able to shed some more light into the timeline when these features will be removed. Deprecation at this point doesn't mean much because it is not introducing any breaking changes, just warnings. I trust CNCF has a solid plan on introducing breaking changes and removing existing functionality.

We will move these into the new system when it is necessary but if you want to move it now, a pull request would be welcomed.

[swnia]

@Xantier Sorry, I was imprecise. In 1.30.0 the old way to instantiate backend plugins for the new backend system was removed...

I.e. I do get errors after upgrading.

packages/backend/src/index.ts:185:3 - error TS2345: Argument of type 'Promise<typeof import("[PATH]/backstage/src/node_modules/@roadiehq/scaffolder-backend-module-http-request/dist/new-backend")>' is not assignable to parameter of type 'BackendFeature | Promise<{ default: BackendFeature; }>'.
  Type 'Promise<typeof import("[PATH]/backstage/src/node_modules/@roadiehq/scaffolder-backend-module-http-request/dist/new-backend")>' is not assignable to type 'Promise<{ default: BackendFeature; }>'.
    Type 'typeof import("[PATH]/backstage/src/node_modules/@roadiehq/scaffolder-backend-module-http-request/dist/new-backend")' is not assignable to type '{ default: BackendFeature; }'.
      Types of property 'default' are incompatible.
        Type '() => BackendFeature' is not assignable to type 'BackendFeature'.
185   import('@roadiehq/scaffolder-backend-module-http-request/new-backend'),

[alexef]

same here. appreciate if anyone has a workaround

[Xantier]

It could be an issue with the latest release, @freben is suggesting to // @ts-ignore this issue for now until they can identify the problem. https://discord.com/channels/687207715902193673/1034089724664610938/1276082713425743903

[alexef]

packages/backend/src/index.ts:62:13 - error TS2345: Argument of type 'Promise<typeof import("/Users/alex/work/stack/node_modules/@roadiehq/scaffolder-backend-module-utils/dist/new-backend")>' is not assignable to parameter of type 'BackendFeature | Promise<{ default: BackendFeature; }>'.
  Type 'Promise<typeof import("/Users/alex/work/stack/node_modules/@roadiehq/scaffolder-backend-module-utils/dist/new-backend")>' is not assignable to type 'Promise<{ default: BackendFeature; }>'.
    Type 'typeof import("/Users/alex/work/stack/node_modules/@roadiehq/scaffolder-backend-module-utils/dist/new-backend")' is not assignable to type '{ default: BackendFeature; }'.
      Types of property 'default' are incompatible.
        Type '() => BackendFeature' is not assignable to type 'BackendFeature'.

62 backend.add(import('@roadiehq/scaffolder-backend-module-utils/new-backend')); // @ts-ignore

ts-ignore doesn't seem to help with utils

[alexef]

nevermind, I should have added it the line before. works

[camilaibs]

@Xantier the way the plugins are initiated are now deprecated with version 1.30.0. Is there a plan to migrate these to the new way of instantiating backend plugins?

@camilaibs maybe able to shed some more light into the timeline when these features will be removed. Deprecation at this point doesn't mean much because it is not introducing any breaking changes, just warnings. I trust CNCF has a solid plan on introducing breaking changes and removing existing functionality.

We will move these into the new system when it is necessary but if you want to move it now, a pull request would be welcomed.

Here is what is recommended for now, adding @Rugvip to the loop 🙂 :
https://discord.com/channels/687207715902193673/1034089724664610938/1276494233263669330

[Rugvip]

@Xantier bumping @backstage/backend-plugin-api to ^0.7.0 in the affected packages will fix the issue

[Rugvip]

In fact, even bumping to the latest version of ^0.6.0 in this repo should fix it too. The issue is that earlier versions of 0.6.x are inlining incompatible types in the published package. Later versions of 0.6.0 will instead export a BackendFeatureCompat type that works with the newer backends. In case you don't want to bump all the way to ^0.7.0