feat(cdn): add cdn backend bucket

Author: james-zhou-inspire11

src/enums/schemasMap.ts

@@ -14,6 +14,7 @@ export default {
   [services.bigQueryDataTransferRun]: 'gcpBigQueryDataTransferRun',
   [services.kmsKeyRing]: 'gcpKmsKeyRing',
   [services.kmsCryptoKeys]: 'gcpKmsCryptoKey',
+  [services.cdnBackendBucket]: 'gcpCdnBackendBucket',
   [services.cloudRouter]: 'gcpCloudRouter',
   [services.dnsManagedZone]: 'gcpDnsManagedZone',
   [services.dnsPolicy]: 'gcpDnsPolicy',

src/enums/serviceMap.ts

@@ -9,6 +9,7 @@ import GcpBigQueryDataTransferRun from '../services/bigQueryDataTransferRun'
 import GcpKmsKeyRing from '../services/kms'
 import GcpKmsCryptoKey from '../services/kmsCryptoKey'
 import GcpCloudRouter from '../services/cloudRouter'
+import GcpCdnBackendBucket from '../services/cdnBackendBucket'
 import GcpDnsManagedZone from '../services/dnsManagedZone'
 import GcpVpc from '../services/vpc'
 import GcpIam from '../services/iam'
@@ -53,6 +54,7 @@ export default {
   [services.kmsKeyRing]: GcpKmsKeyRing,
   [services.kmsCryptoKeys]: GcpKmsCryptoKey,
   [services.cloudRouter]: GcpCloudRouter,
+  [services.cdnBackendBucket]: GcpCdnBackendBucket,
   [services.dnsManagedZone]: GcpDnsManagedZone,
   [services.dnsPolicy]: GcpDnsPolicy,
   [services.vpcConnector]: GcpVpc,

src/enums/services.ts

@@ -22,6 +22,7 @@ export default {
   // bms: 'bms',
   // compute: 'compute',
   // container: 'container',
+  cdnBackendBucket: 'cdnBackendBucket',
   cloudFunction: 'cloudFunction',
   computeProject: 'computeProject',
   // run: 'run',

src/services/cdnBackendBucket/data.ts

@@ -0,0 +1,48 @@
+import groupBy from 'lodash/groupBy'
+import CloudGraph from '@cloudgraph/sdk'
+import { BackendBucketsClient } from '@google-cloud/compute'
+import { google } from '@google-cloud/compute/build/protos/protos'
+import gcpLoggerText from '../../properties/logger'
+import { GcpServiceInput } from '../../types'
+import { generateGcpErrorLog, initTestEndpoint } from '../../utils'
+import { GLOBAL_REGION } from '../../config/constants'
+
+const lt = { ...gcpLoggerText }
+const { logger } = CloudGraph
+const serviceName = 'CDN Backend Bucket'
+const apiEndpoint = initTestEndpoint(serviceName)
+
+export interface RawGcpCdnBackendBucket extends Omit<google.cloud.compute.v1.IBackendBucket, 'id'>    {
+  id: string
+  projectId: string
+  region: string
+}
+
+export default async ({
+  config,
+}: GcpServiceInput): Promise<{
+  [region: string]: RawGcpCdnBackendBucket[]
+}> => {
+    const backendBuckets: RawGcpCdnBackendBucket[] = []
+    const { projectId } = config
+
+    const computeClient = new BackendBucketsClient({ ...config, apiEndpoint })
+
+    try {
+      const backendBucketIter = computeClient.listAsync({project: projectId})
+      for await (const backendBucket of backendBucketIter) {
+        backendBuckets.push({
+          ...backendBucket,
+          id: backendBucket.id.toString(),
+          projectId,
+          region: GLOBAL_REGION,
+        }) 
+      }
+    } catch (error) {
+      generateGcpErrorLog(serviceName, 'cdnBackendBucket:listAsync', error)
+    }
+
+    logger.debug(lt.foundResources(serviceName, backendBuckets.length))
+
+  return groupBy(backendBuckets, 'region')
+}

src/services/cdnBackendBucket/format.ts

@@ -0,0 +1,89 @@
+import { google } from '@google-cloud/compute/build/protos/protos'
+
+import cuid from 'cuid'
+import { RawGcpCdnBackendBucket } from './data'
+import { enumKeyToString } from '../../utils/format'
+import {
+  GcpCdnBackendBucket,
+  GcpCdnBackendBucketCdnPolicy,
+  GcpCdnBackendBucketCdnPolicyNegativeCachingPolicy,
+} from '../../types/generated'
+
+const formatCdnPolicyNegativeCachingPolicy = ({
+  code,
+  ttl,
+}: google.cloud.compute.v1.IBackendBucketCdnPolicyNegativeCachingPolicy): GcpCdnBackendBucketCdnPolicyNegativeCachingPolicy => {
+  return {
+    id: cuid(),
+    code,
+    ttl,
+  }
+}
+
+const formatCdnPolicy = ({
+  bypassCacheOnRequestHeaders,
+  cacheMode,
+  clientTtl,
+  defaultTtl,
+  maxTtl,
+  negativeCaching,
+  negativeCachingPolicy,
+  requestCoalescing,
+  serveWhileStale,
+  signedUrlCacheMaxAgeSec,
+  signedUrlKeyNames,
+}: google.cloud.compute.v1.IBackendBucketCdnPolicy): GcpCdnBackendBucketCdnPolicy => {
+  return {
+    bypassCacheOnRequestHeaderNames: bypassCacheOnRequestHeaders?.map(
+      header => header?.headerName || ''
+    ) || [],
+    cacheMode: enumKeyToString(google.cloud.compute.v1.BackendBucketCdnPolicy.CacheMode, cacheMode),
+    clientTtl,
+    defaultTtl,
+    maxTtl,
+    negativeCaching,
+    negativeCachingPolicy: negativeCachingPolicy?.map(policy => formatCdnPolicyNegativeCachingPolicy(policy)) || [],
+    requestCoalescing,
+    serveWhileStale,
+    signedUrlCacheMaxAgeSec: signedUrlCacheMaxAgeSec?.toString() || '',
+    signedUrlKeyNames,
+  }
+}
+
+export default ({
+  service,
+  account,
+  region,
+}: {
+  service: RawGcpCdnBackendBucket
+  account: string
+  region: string
+}): GcpCdnBackendBucket => {
+  const {
+    bucketName,
+    cdnPolicy = {},
+    creationTimestamp,
+    customResponseHeaders,
+    description,
+    enableCdn,
+    id,
+    kind,
+    name,
+    selfLink,
+  } = service
+
+  return {
+    id,
+    projectId: account,
+    region,
+    name,
+    bucketName,
+    cdnPolicy: formatCdnPolicy(cdnPolicy),
+    creationTimestamp,
+    customResponseHeaders,
+    description,
+    enableCdn,
+    kind,
+    selfLink,
+  }
+}

src/services/cdnBackendBucket/index.ts

@@ -0,0 +1,13 @@
+import { Service } from '@cloudgraph/sdk'
+import BaseService from '../base'
+import format from './format'
+import getData from './data'
+import mutation from './mutation'
+
+export default class GcpCdnBackendBucket extends BaseService implements Service {
+  format = format.bind(this)
+
+  getData = getData.bind(this)
+
+  mutation = mutation;
+}

src/services/cdnBackendBucket/mutation.ts

@@ -0,0 +1,5 @@
+export default `mutation($input: [AddgcpCdnBackendBucketInput!]!) {
+  addgcpCdnBackendBucket(input: $input, upsert: true) {
+    numUids
+  }
+}`;

src/services/cdnBackendBucket/schema.graphql

@@ -0,0 +1,49 @@
+type gcpCdnBackendBucketCdnPolicyNegativeCachingPolicy
+  @generate(
+    query: { get: false, query: true, aggregate: false }
+    mutation: { add: false, delete: false }
+    subscription: false
+  )
+  @key(fields: "id") {
+    id: String! @id
+    code: Int @search
+    ttl: Int @search
+  }
+
+type gcpCdnBackendBucketCdnPolicy
+  @generate(
+    query: { get: false, query: true, aggregate: false }
+    mutation: { add: false, delete: false }
+    subscription: false
+  ) {
+    bypassCacheOnRequestHeaderNames: [String] @search(by: [hash])
+    cacheMode: String @search(by: [hash, regexp])
+    clientTtl: Int @search
+    defaultTtl: Int @search
+    maxTtl: Int @search
+    negativeCaching: Boolean @search
+    negativeCachingPolicy: [gcpCdnBackendBucketCdnPolicyNegativeCachingPolicy]
+    requestCoalescing: Boolean @search
+    serveWhileStale: Int @search
+    signedUrlCacheMaxAgeSec: String @search(by: [hash, regexp])
+    signedUrlKeyNames: [String] @search(by: [hash])
+  }
+
+type gcpCdnBackendBucket implements gcpBaseResource
+  @generate(
+    query: { get: true, query: true, aggregate: true }
+    mutation: { add: true, delete: false }
+    subscription: false
+  )
+  @key(fields: "id") {
+    bucketName: String @search(by: [hash, regexp])
+    cdnPolicy: gcpCdnBackendBucketCdnPolicy
+    creationTimestamp: String @search(by: [hash, regexp])
+    customResponseHeaders: [String] @search(by: [hash])
+    description: String @search(by: [hash, regexp])
+    enableCdn: Boolean @search
+    kind: String @search(by: [hash, regexp])
+    selfLink: String @search(by: [hash, regexp])
+    # cdnUrlMap: [gcpCdnUrlMap] @hasInverse(field: cdnBackendBucket)
+    project: [gcpProject] @hasInverse(field: cdnBackendBucket)
+  }

src/services/project/schema.graphql

@@ -12,6 +12,7 @@ type gcpProject @key(fields: "id") {
   labels: [gcpRawLabel]
   alertPolicy: [gcpAlertPolicy] @hasInverse(field: project)
   apiKeys: [gcpApiKey] @hasInverse(field: project)
+  cdnBackendBucket: [gcpCdnBackendBucket] @hasInverse(field: project)
   cloudFunction: [gcpCloudFunction] @hasInverse(field: project)
   computeProject: [gcpComputeProject] @hasInverse(field: project)
   dnsManagedZone: [gcpDnsManagedZone] @hasInverse(field: project)

src/types/generated.ts

@@ -639,6 +639,38 @@ export type GcpBoolValue = {
   value?: Maybe<Scalars['Boolean']>;
 };
 
+export type GcpCdnBackendBucket = GcpBaseResource & {
+  bucketName?: Maybe<Scalars['String']>;
+  cdnPolicy?: Maybe<GcpCdnBackendBucketCdnPolicy>;
+  creationTimestamp?: Maybe<Scalars['String']>;
+  customResponseHeaders?: Maybe<Array<Maybe<Scalars['String']>>>;
+  description?: Maybe<Scalars['String']>;
+  enableCdn?: Maybe<Scalars['Boolean']>;
+  kind?: Maybe<Scalars['String']>;
+  project?: Maybe<Array<Maybe<GcpProject>>>;
+  selfLink?: Maybe<Scalars['String']>;
+};
+
+export type GcpCdnBackendBucketCdnPolicy = {
+  bypassCacheOnRequestHeaderNames?: Maybe<Array<Maybe<Scalars['String']>>>;
+  cacheMode?: Maybe<Scalars['String']>;
+  clientTtl?: Maybe<Scalars['Int']>;
+  defaultTtl?: Maybe<Scalars['Int']>;
+  maxTtl?: Maybe<Scalars['Int']>;
+  negativeCaching?: Maybe<Scalars['Boolean']>;
+  negativeCachingPolicy?: Maybe<Array<Maybe<GcpCdnBackendBucketCdnPolicyNegativeCachingPolicy>>>;
+  requestCoalescing?: Maybe<Scalars['Boolean']>;
+  serveWhileStale?: Maybe<Scalars['Int']>;
+  signedUrlCacheMaxAgeSec?: Maybe<Scalars['String']>;
+  signedUrlKeyNames?: Maybe<Array<Maybe<Scalars['String']>>>;
+};
+
+export type GcpCdnBackendBucketCdnPolicyNegativeCachingPolicy = {
+  code?: Maybe<Scalars['Int']>;
+  id: Scalars['String'];
+  ttl?: Maybe<Scalars['Int']>;
+};
+
 export type GcpCloudFunction = GcpBaseResource & {
   availableMemoryMb?: Maybe<Scalars['Float']>;
   buildId?: Maybe<Scalars['String']>;
@@ -693,23 +725,23 @@ export type GcpCloudRouter = GcpBaseResource & {
   kind?: Maybe<Scalars['String']>;
   name?: Maybe<Scalars['String']>;
   nats?: Maybe<Array<Maybe<GcpCloudRouterNat>>>;
-  selfLink?: Maybe<Scalars['String']>;
   network?: Maybe<Array<Maybe<GcpNetwork>>>;
   project?: Maybe<Array<Maybe<GcpProject>>>;
+  selfLink?: Maybe<Scalars['String']>;
 };
 
 export type GcpCloudRouterBgpAdvertisedIpRange = {
-  id: Scalars['String'];
   description?: Maybe<Scalars['String']>;
+  id: Scalars['String'];
   range?: Maybe<Scalars['String']>;
 };
 
 export type GcpCloudRouterBgpPeer = {
-  id: Scalars['String'];
   advertiseMode?: Maybe<Scalars['String']>;
   advertisedGroups?: Maybe<Array<Maybe<Scalars['String']>>>;
   advertisedIpRanges?: Maybe<Array<Maybe<GcpCloudRouterBgpPeerAdvertisedIpRange>>>;
   advertisedRoutePriority?: Maybe<Scalars['Int']>;
+  id: Scalars['String'];
   interfaceName?: Maybe<Scalars['String']>;
   ipAddress?: Maybe<Scalars['String']>;
   managementType?: Maybe<Scalars['String']>;
@@ -719,8 +751,8 @@ export type GcpCloudRouterBgpPeer = {
 };
 
 export type GcpCloudRouterBgpPeerAdvertisedIpRange = {
-  id: Scalars['String'];
   description?: Maybe<Scalars['String']>;
+  id: Scalars['String'];
   range?: Maybe<Scalars['String']>;
 };
 
@@ -734,10 +766,10 @@ export type GcpCloudRouterInterface = {
 };
 
 export type GcpCloudRouterNat = {
-  id: Scalars['String'];
   drainNatIps?: Maybe<Array<Maybe<Scalars['String']>>>;
   enableEndpointIndependentMapping?: Maybe<Scalars['Boolean']>;
   icmpIdleTimeoutSec?: Maybe<Scalars['Int']>;
+  id: Scalars['String'];
   logConfigEnable?: Maybe<Scalars['Boolean']>;
   logConfigFilter?: Maybe<Scalars['String']>;
   minPortsPerVm?: Maybe<Scalars['Int']>;
@@ -1242,6 +1274,7 @@ export type GcpMetadata = {
 
 export type GcpNetwork = GcpBaseResource & {
   autoCreateSubnetworks?: Maybe<Scalars['Boolean']>;
+  cloudRouters?: Maybe<Array<Maybe<GcpCloudRouter>>>;
   creationTimestamp?: Maybe<Scalars['String']>;
   description?: Maybe<Scalars['String']>;
   dnsPolicy?: Maybe<Array<Maybe<GcpDnsPolicy>>>;
@@ -1258,7 +1291,6 @@ export type GcpNetwork = GcpBaseResource & {
   subnet?: Maybe<Array<Maybe<GcpSubnet>>>;
   vmInstance?: Maybe<Array<Maybe<GcpVmInstance>>>;
   vpcConnectors?: Maybe<Array<Maybe<GcpVpcConnector>>>;
-  cloudRouters?: Maybe<Array<Maybe<GcpCloudRouter>>>;
 };
 
 export type GcpNetworkPeering = {
@@ -1302,7 +1334,9 @@ export type GcpProject = {
   bigQueryDataset?: Maybe<Array<Maybe<GcpBigQueryDataset>>>;
   bigQueryReservation?: Maybe<Array<Maybe<GcpBigQueryReservation>>>;
   bigQueryReservationCapacityCommitment?: Maybe<Array<Maybe<GcpBigQueryReservationCapacityCommitment>>>;
+  cdnBackendBucket?: Maybe<Array<Maybe<GcpCdnBackendBucket>>>;
   cloudFunction?: Maybe<Array<Maybe<GcpCloudFunction>>>;
+  cloudRouters?: Maybe<Array<Maybe<GcpCloudRouter>>>;
   computeProject?: Maybe<Array<Maybe<GcpComputeProject>>>;
   createTime?: Maybe<Scalars['String']>;
   deleteTime?: Maybe<Scalars['String']>;
@@ -1312,7 +1346,6 @@ export type GcpProject = {
   etag?: Maybe<Scalars['String']>;
   firewall?: Maybe<Array<Maybe<GcpFirewall>>>;
   folder?: Maybe<Array<Maybe<GcpFolder>>>;
-  cloudRouters?: Maybe<Array<Maybe<GcpCloudRouter>>>;
   iamPolicy?: Maybe<Array<Maybe<GcpIamPolicy>>>;
   id: Scalars['String'];
   kmsCryptoKeys?: Maybe<Array<Maybe<GcpKmsCryptoKey>>>;