anakzr / backstage-plugin-library-check Goto Github PK

Description

Hi
I am planning to intergrate this plugin with my service catalog, but it would be useful if we have support for java gradle based projects aswell as golang (go.mod)

Problem Statement/Justification

Extending to java grade and go.mod

Proposed Solution or API

For gradle, we can check the modules. for golang, lets check the go.mod

Alternatives

No response

Additional Information

No response

Description

When I tested plugin local (better-sqlite), the plugins does not work. It seems to have problems with saving the metadata to the database with err message LibraryCheckService: Error trying to save libraries on database.

Link to Reproduction

https://example.com

Steps to reproduce

Using the newest Version (Backend 0.1.0) of the plugin with Backstage 1.23.2.

// backend/src/index.ts

import libraryCheck from './plugins/libraryCheck';
// ...

const libraryCheckEnv = useHotMemoize(module, () =>
  createEnv('libraryCheck'),
);
// ...

apiRouter.use('/library-check', await libraryCheck(libraryCheckEnv));

// backend/src/plugins/libraryCheck.ts

import { PluginEnvironment } from '../types';
import { Router } from 'express';
import {
  DatabaseLibraryCheckStore,
  createRouter,
} from '@anakz/backstage-plugin-library-check-backend';

export default async function createPlugin({
  logger,
  database,
  config,
}: PluginEnvironment): Promise<Router> {
  const db = await DatabaseLibraryCheckStore.create({
    database: database,
  });
  return await createRouter({
    logger,
    database: db,
    config,
  });
}

// backend/src/plugins/catalog.ts

import {
  LibraryCheckProcessor,
  LibraryCheckProvider,
  LibraryCheckUpdaterProcessor,
} from '@anakz/backstage-plugin-library-check-backend';

// ...

  builder.addEntityProvider(
    LibraryCheckProvider.fromConfig({
      envId: 'production',
      logger: env.logger,
      discovery: env.discovery,
      schedule: env.scheduler.createScheduledTaskRunner({
        initialDelay: {
          seconds: 30,
        },
        frequency: {
          minutes: 60,
        },
        timeout: {
          minutes: 1,
        },
      }),
    }),
  );

  builder.addProcessor(
    LibraryCheckProcessor.fromConfig(env.config, {
      discoveryService: env.discovery,
      reader: env.reader,
      logger: env.logger,
    }),
    LibraryCheckUpdaterProcessor.fromConfig(env.config, {
      discoveryService: env.discovery,
      reader: env.reader,
      logger: env.logger,
    }),
  );

// ...

Plugin Version

0.1.0

Browser

No response

Operating System

• macOS
• Windows
• Linux

Additional Information

No response

Description

Hi this is wonderful tool to keep track of changes in code, and am looking forward for the future addition for java and golang.

However for better adoption for future backstage users, can we migrate to the new backend?

Plugin

• library check frontend
• library check backend

Additional Information

No response

Description

This is a very useful tool, and being able to track open source dependencies on it's own is super useful, but I would love to also be able to track any/all dependencies installed from private repositories as well. For instance we use Gemfury to host our private Ruby and Python packages, and would love to have an easy way to track which services aren't up-to-date on our those packages as well.

I know this is a larger ask, with a need for potential UI changes to be able to sort/filter based on private vs. public as well as configuration needs for the varying supported languages and would love to collaborate if you think it's worth while.

Plugin

• library check frontend
• library check backend

Additional Information

No response

Description

Highlight code occurrences for the library in code view.

Problem Statement/Justification

It would be better to see the work needed for refactoring.

Proposed Solution or API

Use a different background color for occurrence.

Alternatives

No response

Additional Information

No response

Description

Currently there is no support for catalogs that have static files stored in AWS S3.

Problem Statement/Justification

As there is no support for AWS S3 catalog integration, we can't use the plugin since is unable to locate the descriptor file.

Proposed Solution or API

In the case of locations of type file, some of the well-known annotations such as backstage.io/source-location or github.com/project-slug can be used to make the search and find the descriptors.

Alternatives

No response

Additional Information

No response