app-backend: added utility to find assets to store

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

plugins/app-backend/src/lib/assets/StaticAssetsStore.ts

@@ -19,23 +19,13 @@ import { Knex } from 'knex';
 import { Logger } from 'winston';
 import { DateTime } from 'luxon';
 import partition from 'lodash/partition';
+import { StaticAsset, StaticAssetInput } from './types';
 
 const migrationsDir = resolvePackagePath(
   '@backstage/plugin-app-backend',
   'migrations',
 );
 
-export interface StaticAssetInput {
-  path: string;
-  content(): Promise<Buffer>;
-}
-
-export interface StaticAsset {
-  path: string;
-  content: Buffer;
-  lastModifiedAt: Date;
-}
-
 interface StaticAssetRow {
   path: string;
   content: Buffer;

plugins/app-backend/src/lib/assets/findStaticAssets.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import fs from 'fs-extra';
+import globby from 'globby';
+import { StaticAssetInput } from './types';
+import { resolveSafeChildPath } from '@backstage/backend-common';
+
+export async function findStaticAssets(
+  staticDir: string,
+): Promise<StaticAssetInput[]> {
+  const assetPaths = await globby('**/*', {
+    ignore: ['**/*.map'], // Ignore source maps since they're quite large
+    cwd: staticDir,
+    dot: true,
+  });
+
+  return assetPaths.map(path => ({
+    path,
+    content: async () => fs.readFile(resolveSafeChildPath(staticDir, path)),
+  }));
+}

plugins/app-backend/src/lib/assets/index.ts

@@ -15,4 +15,5 @@
  */
 
 export { StaticAssetsStore } from './StaticAssetsStore';
-export type { StaticAsset, StaticAssetInput } from './StaticAssetsStore';
+export type { StaticAsset, StaticAssetInput } from './types';
+export { findStaticAssets } from './findStaticAssets';

plugins/app-backend/src/lib/assets/types.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface StaticAssetInput {
+  path: string;
+  content(): Promise<Buffer>;
+}
+
+export interface StaticAsset {
+  path: string;
+  content: Buffer;
+  lastModifiedAt: Date;
+}