Merge remote-tracking branch 'origin' into julio/log-browser-url

Author: juliobguedes

.vtex/catalog-info.yaml

@@ -0,0 +1,20 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: toolbelt
+  description: CLI that offers all you need to start using the VTEX IO platform efficiently
+  tags:
+    - typescript
+    - oclif
+  annotations:
+    vtex.com/janus-acronym: ""
+    vtex.com/o11y-os-index: ""
+    grafana/dashboard-selector: ""
+    github.com/project-slug: vtex/toolbelt
+    backstage.io/techdocs-ref: dir:../
+    vtex.com/application-id: 5YP7PPID
+spec:
+  lifecycle: stable
+  owner: te-0029
+  type: cli
+  dependsOn: []

.vtex/deployment.yaml

@@ -0,0 +1,16 @@
+- name: toolbelt
+  build:
+    provider: dkcicd
+    pipelines:
+      - name: techdocs-v1
+        parameters:
+          entityReference: default/component/toolbelt
+          sourceDir: ./
+        when:
+          - event: push
+            source: branch
+            regex: main
+            path:
+              - "docs/**"
+              - README.md
+              - .vtex/deployment.yaml

CHANGELOG.md

@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Updated
+- Extend VBase client, integrating the `getConflicts` and the `resolveConflict` endpoints.
 
 ### Fixed
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vtex",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "The platform for e-commerce apps",
   "bin": "bin/run",
   "main": "lib/api/index.js",

src/api/clients/IOClients/infra/VBase.ts

@@ -2,8 +2,9 @@ import { InfraClient, InstanceOptions, IOContext } from '@vtex/api'
 import { IOClientFactory } from '../IOClientFactory'
 
 const routes = {
-  Bucket: (bucket: string) => `/buckets/${bucket}`,
-  File: (bucket: string, path: string) => `${routes.Bucket(bucket)}/userData/files/${path}`,
+  Bucket: (bucket: string) => `${bucket}`,
+  File: (bucket: string, path: string) => `buckets/${routes.Bucket(bucket)}/files/${path}`,
+  Conflicts: (bucket: string) => `buckets/${routes.Bucket(bucket)}/conflicts`,
 }
 
 export class VBase extends InfraClient {
@@ -21,16 +22,32 @@ export class VBase extends InfraClient {
     })
   }
 
+  // Resolve a specific pages-graphql conflict
+  public resolveConflict = (bucketKey: string, path: string, content: any) => {
+    const data = [
+      {
+        op: 'replace',
+        path,
+        value: content,
+      },
+    ]
+
+    return this.http.patch(routes.Conflicts(`vtex.pages-graphql/${bucketKey}`), data, {
+      metric: 'vbase-resolve-conflicts',
+    })
+  }
+
+  // List all conflicts in the pages-graphql bucket
+  public getConflicts = async () => {
+    return this.http.get(routes.Conflicts('vtex.pages-graphql/userData'), {
+      metric: 'vbase-get-conflicts',
+    })
+  }
+
+  // Verify if there is at least one conlfict in the pages-graphql bucket
   public checkForConflicts = async () => {
-    let status: number
-    try {
-      const response = await this.http.get(routes.File('vtex.pages-graphql', 'store/content.json'), {
-        metric: 'vbase-conflict',
-      })
-      status = response.status
-    } catch (error) {
-      status = error.response && error.response.status
-    }
-    return status === 409
+    const response = await this.getConflicts().then(res => res.data)
+
+    return response?.length > 0
   }
 }