Merge pull request #317 from gastrohero/feature/add-google-cloud-storage-cache

Added google cloud storage cache as caching option and changelog entry for this feature

Author: pkarw

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - mage2vs import now has optional `--generate-unique-url-keys` parameter which defaults to `false` to enable/disable the url key generation with name and id for categories - @rain2o (#232)
 - Added eslint config from vue-storefront so we have the same config and in both repos typescript support - @resubaka (#320)
 - Added jest support - @resubaka (#321)
+- Added caching factory and action factory for the image endpoint. This gives the possibility to use other services for caching or image processing - @resubaka (#317, #315)
 
 ### Fixed
 - The `product.price_*` fields have been normalized with the backward compatibility support (see `config.tax.deprecatedPriceFieldsSupport` which is by default true) - @pkarw (#289)

config/default.json

@@ -229,6 +229,11 @@
       "type": "file",
       "file": {
         "path": "/tmp/vue-storefront-api"
+      },
+      "google-cloud-storage": {
+        "libraryOptions": {},
+        "bucket": "",
+        "prefix": "vue-storefront-api/image-cache"
       }
     },
     "action": {

package.json

@@ -45,6 +45,7 @@
   "author": "Piotr Karwatka <pkarwatka@divante.pl>",
   "license": "MIT",
   "dependencies": {
+    "@google-cloud/storage": "^3.0.3",
     "ajv": "^6.4.0",
     "ajv-keywords": "^3.4.0",
     "body-parser": "^1.18.2",

src/image/cache/google-cloud-storage/index.ts

@@ -0,0 +1,51 @@
+import ImageCache from '../abstract'
+import { createHash } from 'crypto'
+import { Bucket, Storage } from '@google-cloud/storage'
+export default class GoogleCloudStorageImageCache extends ImageCache {
+  private static storage: Storage
+  private static bucket: Bucket
+
+  public constructor (config, req) {
+    super(config, req)
+    if (GoogleCloudStorageImageCache.storage === undefined) {
+      GoogleCloudStorageImageCache.storage = new Storage(
+        this.moduleConfig.libraryOptions
+      )
+    }
+    if (GoogleCloudStorageImageCache.bucket === undefined) {
+      GoogleCloudStorageImageCache.bucket = GoogleCloudStorageImageCache.storage.bucket(this.bucketName)
+    }
+  }
+
+  public get bucketName (): string {
+    return this.moduleConfig.bucket
+  }
+
+  public get moduleConfig (): any {
+    return this.config.imageable.caching[`google-cloud-storage`]
+  }
+
+  public async getImageFromCache () {
+    const donwload = await GoogleCloudStorageImageCache.bucket.file('testing/cache/image/' + this.key).download()
+    this.image = donwload[0]
+  }
+
+  public async save () {
+    await GoogleCloudStorageImageCache.bucket.file('testing/cache/image/' + this.key).save(this.image, {
+      gzip: true
+    })
+  }
+
+  public async check () {
+    const response = await GoogleCloudStorageImageCache.bucket.file('testing/cache/image/' + this.key).exists()
+    return response[0]
+  }
+
+  public createKey (): string {
+    return createHash('md5').update(this.req.url).digest('hex')
+  }
+
+  public isValidFor (type) {
+    return type === 'google-cloud-storage'
+  }
+}