@genoacms/adapter-gcp 0.4.2 → 0.5.2-fix.10

package/deployment/snippets/index.js

@@ -0,0 +1,8 @@
+import { handler } from './build/handler.js'
+
+function genoacms (req, res) {
+  handler(req, res, undefined)
+}
+
+export { genoacms }
+

package/dist/services/deployment/deploy.d.ts

@@ -0,0 +1,2 @@
+declare function deploy(): Promise<void>;
+export default deploy;

package/dist/services/deployment/deploy.js

@@ -0,0 +1,111 @@
+import config from '../../config.js';
+import { createReadStream, createWriteStream } from 'node:fs';
+import { resolve, dirname, basename } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { v2 } from '@google-cloud/functions';
+import archiver from 'archiver';
+const { FunctionServiceClient } = v2;
+const functionsClient = new FunctionServiceClient({
+    credentials: config.deployment.credentials
+});
+const projectId = config.deployment.projectId;
+const region = config.deployment.region;
+const currentDir = dirname(fileURLToPath(import.meta.url));
+async function createZip(source, injectPaths, ignorePaths, out) {
+    await new Promise((resolve, reject) => {
+        const output = createWriteStream(out);
+        const archive = archiver('zip', { zlib: { level: 9 } });
+        output.on('close', () => {
+            resolve();
+        });
+        archive.on('error', (err) => {
+            reject(err);
+        });
+        archive.pipe(output);
+        archive.glob(source, { ignore: ignorePaths });
+        for (const path of injectPaths) {
+            archive.file(path, { name: basename(path) });
+        }
+        archive.finalize();
+    });
+}
+async function uploadSource(sourceArchivePath) {
+    const location = functionsClient.locationPath(projectId, region);
+    const [urlResponse] = await functionsClient.generateUploadUrl({ parent: location });
+    const uploadUrl = urlResponse.uploadUrl;
+    const storageSource = urlResponse.storageSource;
+    if (!uploadUrl || !storageSource)
+        throw new Error('Upload URL not found');
+    const sourceArchiveStream = createReadStream(sourceArchivePath);
+    await fetch(uploadUrl, {
+        method: 'PUT',
+        // @ts-expect-error: invalid typings
+        body: sourceArchiveStream,
+        duplex: 'half',
+        headers: {
+            'Content-Type': 'application/zip'
+        }
+    });
+    return storageSource;
+}
+async function deployFunction(functionName, storageSource) {
+    const location = functionsClient.locationPath(projectId, region);
+    const name = functionsClient.functionPath(projectId, region, functionName);
+    let isFunctionExisting;
+    try {
+        await functionsClient.getFunction({ name });
+        isFunctionExisting = true;
+    }
+    catch (error) {
+        isFunctionExisting = false;
+    }
+    const operationParams = {
+        functionId: functionName,
+        parent: location,
+        function: {
+            name,
+            buildConfig: {
+                entryPoint: 'genoacms',
+                runtime: 'nodejs20',
+                source: {
+                    storageSource
+                }
+            },
+            serviceConfig: {
+                minInstanceCount: 0,
+                maxInstanceCount: 1,
+                ingressSettings: 1,
+                environmentVariables: {
+                    NODE_ENV: 'production'
+                }
+            }
+        }
+    };
+    let response;
+    if (isFunctionExisting) {
+        [response] = await functionsClient.updateFunction(operationParams);
+    }
+    else {
+        [response] = await functionsClient.createFunction(operationParams);
+    }
+    console.log(response);
+}
+async function deploy() {
+    const buildDirectoryPath = '**';
+    const buildArchivePath = resolve(currentDir, '../../../deployment/build.zip');
+    const functionEntryScriptPath = resolve(currentDir, '../../../deployment/snippets/index.js');
+    const ignoreArchivePaths = [
+        'node_modules/**',
+        '.git/**',
+        '.github/**',
+        '.gitignore',
+        'build/**'
+    ];
+    const injectArchivePaths = [
+        functionEntryScriptPath
+    ];
+    await createZip(buildDirectoryPath, injectArchivePaths, ignoreArchivePaths, buildArchivePath);
+    const functionStorageSource = await uploadSource(buildArchivePath);
+    await deployFunction('genoacms', functionStorageSource);
+}
+export default deploy;

package/dist/services/deployment/index.d.ts

@@ -0,0 +1,4 @@
+import type { Adapter } from '@genoacms/cloudabstraction/deployment';
+declare const svelteKitAdapter: Adapter.svelteKitAdapter;
+declare const deployProcedure: Adapter.deployProcedure;
+export { svelteKitAdapter, deployProcedure };

package/dist/services/deployment/index.js

@@ -0,0 +1,6 @@
+const svelteKitAdapter = '@sveltejs/adapter-node';
+const deployProcedure = async () => {
+    const deploy = (await import('./deploy.js')).default;
+    await deploy();
+};
+export { svelteKitAdapter, deployProcedure };

package/dist/services/storage/index.js

@@ -1,14 +1,5 @@
-import { Storage } from '@google-cloud/storage';
-import config from '../../config.js';
-const storage = new Storage({
-    credentials: config.storage.credentials
-});
-const getBucket = (name) => {
-    if (!config.storage.buckets.includes(name))
-        throw new Error('bucket-unregistered');
-    const bucket = storage.bucket(name);
-    return bucket;
-};
+import { getBucket } from './storage.js';
+import { join } from 'path';
 const getObject = async ({ bucket, name }) => {
     const bucketInstance = getBucket(bucket);
     const file = bucketInstance.file(name);
@@ -21,21 +12,19 @@ const getPublicURL = async ({ bucket, name }) => {
     const file = bucketInstance.file(name);
     return file.publicUrl();
 };
-const getSignedURL = async ({ bucket, name }) => {
+const getSignedURL = async ({ bucket, name }, expires) => {
     const bucketInstance = getBucket(bucket);
     const file = bucketInstance.file(name);
-    const expires = new Date();
-    expires.setTime(expires.getTime() + 60 * 60 * 1_000);
     const [url] = await file.getSignedUrl({
         action: 'read',
         expires
     });
     return url;
 };
-const uploadObject = async ({ bucket, name }, stream) => {
+const uploadObject = async ({ bucket, name }, stream, options) => {
     const bucketInstance = getBucket(bucket);
     const file = bucketInstance.file(name);
-    await file.save(stream);
+    await file.save(stream, options);
 };
 const deleteObject = async ({ bucket, name }) => {
     const bucketInstance = getBucket(bucket);
@@ -46,7 +35,7 @@ const listDirectory = async ({ bucket, name }, listingParams = {}) => {
     const bucketInstance = getBucket(bucket);
     const options = {
         autoPaginate: false,
-        prefix: name,
+        prefix: join(name, '/'),
         maxResults: listingParams?.limit,
         startOffset: listingParams?.startAfter,
         delimiter: '/'
@@ -62,7 +51,7 @@ const listDirectory = async ({ bucket, name }, listingParams = {}) => {
                 lastModified: new Date(file.metadata.updated)
             };
         }),
-        directories: apiResponse?.prefixes ?? []
+        directories: (apiResponse?.prefixes ?? []).filter((item) => item !== name)
     };
 };
 const createDirectory = async ({ bucket, name }) => {

package/dist/services/storage/storage.d.ts

@@ -0,0 +1,3 @@
+import { type Bucket } from '@google-cloud/storage';
+declare const getBucket: (name: string) => Bucket;
+export { getBucket };

package/dist/services/storage/storage.js

@@ -0,0 +1,12 @@
+import config from '../../config.js';
+import { Storage } from '@google-cloud/storage';
+const storage = new Storage({
+    credentials: config.storage.credentials
+});
+const getBucket = (name) => {
+    if (!config.storage.buckets.includes(name))
+        throw new Error('bucket-unregistered');
+    const bucket = storage.bucket(name);
+    return bucket;
+};
+export { getBucket };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@genoacms/adapter-gcp",
-  "version": "0.4.2",
+  "version": "0.5.2-fix.10",
   "description": "Implementation of abstraction layer of GenoaCMS for GCP",
   "repository": {
     "type": "git",
@@ -17,12 +17,15 @@
   "homepage": "https://github.com/GenoaCMS/adapter-gcp#readme",
   "type": "module",
   "dependencies": {
-    "@genoacms/cloudabstraction": "0.4.2-fix.2",
+    "@genoacms/cloudabstraction": "^0.5.2",
     "@google-cloud/firestore": "^7.1.0",
+    "@google-cloud/functions": "^3.4.0",
     "@google-cloud/resource-manager": "^5.1.0",
-    "@google-cloud/storage": "^7.7.0"
+    "@google-cloud/storage": "^7.7.0",
+    "archiver": "^7.0.0"
   },
   "devDependencies": {
+    "@types/archiver": "^6.0.2",
     "@typescript-eslint/eslint-plugin": "^6.9.0",
     "eslint": "^8.52.0",
     "eslint-config-standard-with-typescript": "^39.1.1",
@@ -33,8 +36,12 @@
     "typescript": "^5.2.2",
     "vitest": "^1.0.4"
   },
+  "peerDependencies": {
+    "@sveltejs/adapter-node": "^4.0.1"
+  },
   "files": [
     "src",
+    "deployment",
     "dist"
   ],
   "exports": {
@@ -46,6 +53,10 @@
       "import": "./dist/services/database/index.js",
       "types": "./dist/services/database/index.d.ts"
     },
+    "./deployment": {
+      "import": "./dist/services/deployment/index.js",
+      "types": "./dist/services/deployment/index.d.ts"
+    },
     "./storage": {
       "import": "./dist/services/storage/index.js",
       "types": "./dist/services/storage/index.d.ts"

package/src/services/deployment/deploy.ts

@@ -0,0 +1,120 @@
+import config from '../../config.js'
+import { createReadStream, createWriteStream } from 'node:fs'
+import { resolve, dirname, basename } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { v2 } from '@google-cloud/functions'
+import archiver from 'archiver'
+import type { google } from '@google-cloud/functions/build/protos/protos.js'
+type IStorageSource = google.cloud.functions.v2.IStorageSource
+
+const { FunctionServiceClient } = v2
+const functionsClient = new FunctionServiceClient({
+  credentials: config.deployment.credentials
+})
+const projectId = config.deployment.projectId
+const region = config.deployment.region
+
+const currentDir = dirname(fileURLToPath(import.meta.url))
+
+async function createZip (source: string, injectPaths: string[], ignorePaths: string[], out: string): Promise<void> {
+  await new Promise<void>((resolve, reject) => {
+    const output = createWriteStream(out)
+    const archive = archiver('zip', { zlib: { level: 9 } })
+
+    output.on('close', () => {
+      resolve()
+    })
+
+    archive.on('error', (err) => {
+      reject(err)
+    })
+
+    archive.pipe(output)
+    archive.glob(source, { ignore: ignorePaths })
+    for (const path of injectPaths) {
+      archive.file(path, { name: basename(path) })
+    }
+    archive.finalize()
+  })
+}
+
+async function uploadSource (sourceArchivePath: string): Promise<IStorageSource> {
+  const location = functionsClient.locationPath(projectId, region)
+  const [urlResponse] = await functionsClient.generateUploadUrl({ parent: location })
+  const uploadUrl = urlResponse.uploadUrl
+  const storageSource = urlResponse.storageSource
+  if (!uploadUrl || !storageSource) throw new Error('Upload URL not found')
+  const sourceArchiveStream = createReadStream(sourceArchivePath)
+  await fetch(uploadUrl, {
+    method: 'PUT',
+    // @ts-expect-error: invalid typings
+    body: sourceArchiveStream,
+    duplex: 'half',
+    headers: {
+      'Content-Type': 'application/zip'
+    }
+  })
+  return storageSource
+}
+
+async function deployFunction (functionName: string, storageSource: IStorageSource): Promise<void> {
+  const location = functionsClient.locationPath(projectId, region)
+  const name = functionsClient.functionPath(projectId, region, functionName)
+  let isFunctionExisting: boolean
+  try {
+    await functionsClient.getFunction({ name })
+    isFunctionExisting = true
+  } catch (error) {
+    isFunctionExisting = false
+  }
+  const operationParams = {
+    functionId: functionName,
+    parent: location,
+    function: {
+      name,
+      buildConfig: {
+        entryPoint: 'genoacms',
+        runtime: 'nodejs20',
+        source: {
+          storageSource
+        }
+      },
+      serviceConfig: {
+        minInstanceCount: 0,
+        maxInstanceCount: 1,
+        ingressSettings: 1, // ALLOW_ALL
+        environmentVariables: {
+          NODE_ENV: 'production'
+        }
+      }
+    }
+  }
+  let response
+  if (isFunctionExisting) {
+    [response] = await functionsClient.updateFunction(operationParams)
+  } else {
+    [response] = await functionsClient.createFunction(operationParams)
+  }
+  console.log(response)
+}
+
+async function deploy (): Promise<void> {
+  const buildDirectoryPath = '**'
+  const buildArchivePath = resolve(currentDir, '../../../deployment/build.zip')
+  const functionEntryScriptPath = resolve(currentDir, '../../../deployment/snippets/index.js')
+  const ignoreArchivePaths = [
+    'node_modules/**',
+    '.git/**',
+    '.github/**',
+    '.gitignore',
+    'build/**'
+  ]
+  const injectArchivePaths = [
+    functionEntryScriptPath
+  ]
+  await createZip(buildDirectoryPath, injectArchivePaths, ignoreArchivePaths, buildArchivePath)
+  const functionStorageSource = await uploadSource(buildArchivePath)
+  await deployFunction('genoacms', functionStorageSource)
+}
+
+export default deploy

package/src/services/deployment/index.ts

@@ -0,0 +1,13 @@
+import type { Adapter } from '@genoacms/cloudabstraction/deployment'
+
+const svelteKitAdapter: Adapter.svelteKitAdapter = '@sveltejs/adapter-node'
+
+const deployProcedure: Adapter.deployProcedure = async () => {
+  const deploy = (await import('./deploy.js')).default
+  await deploy()
+}
+
+export {
+  svelteKitAdapter,
+  deployProcedure
+}

package/src/services/storage/index.ts

@@ -2,18 +2,9 @@ import type {
   Adapter,
   StorageObject
 } from '@genoacms/cloudabstraction/storage'
-import { type Bucket, Storage, type File } from '@google-cloud/storage'
-import config from '../../config.js'
-
-const storage = new Storage({
-  credentials: config.storage.credentials
-})
-
-const getBucket = (name: string): Bucket => {
-  if (!config.storage.buckets.includes(name)) throw new Error('bucket-unregistered')
-  const bucket = storage.bucket(name)
-  return bucket
-}
+import { type File } from '@google-cloud/storage'
+import { getBucket } from './storage.js'
+import { join } from 'path'
 
 const getObject: Adapter.getObject = async ({ bucket, name }) => {
   const bucketInstance = getBucket(bucket)
@@ -30,11 +21,9 @@ const getPublicURL: Adapter.getPublicURL = async ({ bucket, name }) => {
   return file.publicUrl()
 }
 
-const getSignedURL: Adapter.getSignedURL = async ({ bucket, name }) => {
+const getSignedURL: Adapter.getSignedURL = async ({ bucket, name }, expires) => {
   const bucketInstance = getBucket(bucket)
   const file = bucketInstance.file(name)
-  const expires = new Date()
-  expires.setTime(expires.getTime() + 60 * 60 * 1_000)
   const [url] = await file.getSignedUrl({
     action: 'read',
     expires
@@ -42,10 +31,10 @@ const getSignedURL: Adapter.getSignedURL = async ({ bucket, name }) => {
   return url
 }
 
-const uploadObject: Adapter.uploadObject = async ({ bucket, name }, stream) => {
+const uploadObject: Adapter.uploadObject = async ({ bucket, name }, stream, options) => {
   const bucketInstance = getBucket(bucket)
   const file = bucketInstance.file(name)
-  await file.save(stream)
+  await file.save(stream, options)
 }
 
 const deleteObject: Adapter.deleteObject = async ({ bucket, name }) => {
@@ -58,7 +47,7 @@ const listDirectory: Adapter.listDirectory = async ({ bucket, name }, listingPar
   const bucketInstance = getBucket(bucket)
   const options = {
     autoPaginate: false,
-    prefix: name,
+    prefix: join(name, '/'),
     maxResults: listingParams?.limit,
     startOffset: listingParams?.startAfter,
     delimiter: '/'
@@ -77,7 +66,7 @@ const listDirectory: Adapter.listDirectory = async ({ bucket, name }, listingPar
         lastModified: new Date(file.metadata.updated as string)
       } satisfies StorageObject
     }),
-    directories: apiResponse?.prefixes ?? []
+    directories: (apiResponse?.prefixes ?? []).filter((item) => item !== name)
   }
 }
 

package/src/services/storage/storage.ts

@@ -0,0 +1,16 @@
+import config from '../../config.js'
+import { type Bucket, Storage } from '@google-cloud/storage'
+
+const storage = new Storage({
+  credentials: config.storage.credentials
+})
+
+const getBucket = (name: string): Bucket => {
+  if (!config.storage.buckets.includes(name)) throw new Error('bucket-unregistered')
+  const bucket = storage.bucket(name)
+  return bucket
+}
+
+export {
+  getBucket
+}