Read app-config.yaml setting at Custom Field Extensions. | Backstage | Page 1

normal flicker Jul 31, 2024, 6:01 PM

#

I am not able to read the value with this config:

import { useApi, configApiRef } from '@backstage/core-plugin-api';
const config = useApi(configApiRef);
const token = config.getString('secrets.token');

Is this ok ? Or I am missing something.

keen sedge Jul 31, 2024, 6:35 PM

#

Hi @normal flicker, looks fine, without seeing the config schema for this a guess is that it could be related to the visibility: https://backstage.io/docs/conf/defining#visibility.

normal flicker Jul 31, 2024, 6:36 PM

#

I tried to create the config.d.ts file into package/app. The I edit the package.json to add
{
// ...
"files": [
// ...
"config.d.ts"
],
"configSchema": "config.d.ts"
}

But it does not work.

keen sedge Jul 31, 2024, 6:46 PM

#

Can you share the config.d.ts ?

normal flicker Jul 31, 2024, 6:56 PM

#

export interface Config {
    /**
     * Visible in frontend and backend
     * @visibility frontend
     */
  secrets: {
      token: string;
  };
}

#

Now, I added this file and the package.json into the custom field extension that I created. But the problem persists.

keen sedge Jul 31, 2024, 6:58 PM

#

You need to add visibility to the token as well, it's need on each property

normal flicker Jul 31, 2024, 7:00 PM

#

I added:
visibility: frontend

keen sedge Jul 31, 2024, 7:33 PM

#

Did that work?

normal flicker Jul 31, 2024, 7:38 PM

#

No

#

where should create teh file config.d.ts ? into teh package/app ?

keen sedge Jul 31, 2024, 7:42 PM

#

So it looks like this and it still doesn't work?

export interface Config {
  /**
   * Visible in frontend and backend
   * @visibility frontend
   */
  secrets: {
    /**
     * Visible in frontend and backend
     * @visibility frontend
     */
    token: string,
  };
}

normal flicker Jul 31, 2024, 7:46 PM

#

yes, it does not work

keen sedge Jul 31, 2024, 7:47 PM

#

OK, then I don't have anything further to suggest sadly

normal flicker Jul 31, 2024, 7:50 PM

#

@keen sedge where the config.d.ts should be keep ?

keen sedge Jul 31, 2024, 7:51 PM

#

In packages/app as you mentioned should be fine.

normal flicker Jul 31, 2024, 7:54 PM

#

it is working. I clean up and restart everything

#

Thank you @keen sedge

#Read app-config.yaml setting at Custom Field Extensions.